{ "openapi": "3.1.0", "info": { "title": "Zoho ToDo API", "version": "1.0.0" }, "tags": [ { "name": "task", "description": "Manage personal tasks, to-dos, and action items." }, { "name": "group-task", "description": "Manage group or team tasks and shared to-dos." }, { "name": "subtask", "description": "Manage subtasks under a parent task." }, { "name": "category", "description": "Manage task categories, task lists, and task groups." } ], "paths": { "/api/tasks/groups/{groupId}/{taskId}/subtasks": { "get": { "tags": [ "subtask" ], "x-mcp-group": [ "Subtask" ], "description": "To get subtasks for the given group task", "operationId": "getSubtasksForGroupTask", "parameters": [ { "name": "groupId", "in": "path", "description": "identifier for group", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "taskId", "in": "path", "description": "identifier for task", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listResponseJSON" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.tasks.ALL", "ZohoMail.tasks.READ" ] } ] } }, "/api/tasks/me/{taskId}/subtasks": { "get": { "tags": [ "subtask" ], "x-mcp-group": [ "Subtask" ], "description": "To get subtasks for the given personal task", "operationId": "getSubtasksForPersonalTask", "parameters": [ { "name": "taskId", "in": "path", "description": "identifier for task", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listResponseJSON" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.tasks.ALL", "ZohoMail.tasks.READ" ] } ] } }, "/api/tasks/groups/{groupId}/categories": { "get": { "tags": [ "category" ], "x-mcp-group": [ "Category" ], "description": "To get categories in a group", "operationId": "getCategoriesInGroupTasks", "parameters": [ { "name": "defaultCategory", "in": "query", "description": "is default category details needed in response", "schema": { "type": "boolean" } }, { "name": "groupId", "in": "path", "description": "identifier for group", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/categoryListResponseJSON" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.tasks.ALL", "ZohoMail.tasks.READ" ] } ] }, "post": { "tags": [ "category" ], "x-mcp-group": [ "Category" ], "description": "To add a category in a group", "operationId": "addCategoriesInGroupTasks", "parameters": [ { "name": "groupId", "in": "path", "description": "identifier for group", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Name for category to be created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/categoryJSON" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/categorySingleResponseJSON" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.tasks.ALL", "ZohoMail.tasks.CREATE" ] } ] } }, "/api/tasks/groups/{groupId}/{taskId}": { "get": { "tags": [ "group-task" ], "x-mcp-group": [ "Group Task" ], "description": "To get a single group task", "operationId": "getGroupTask", "parameters": [ { "name": "groupId", "in": "path", "description": "identifier for group", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "taskId", "in": "path", "description": "identifier for task", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listResponseJSON" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.tasks.ALL", "ZohoMail.tasks.READ" ] } ] }, "put": { "tags": [ "group-task" ], "x-mcp-group": [ "Group Task" ], "description": "To edit a task in a group", "operationId": "editGroupTask", "parameters": [ { "name": "groupId", "in": "path", "description": "identifier for group", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "taskId", "in": "path", "description": "identifier for task", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Task fields to be updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/editTaskJSON" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responseJSON" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.tasks.ALL", "ZohoMail.tasks.UPDATE" ] } ] }, "delete": { "tags": [ "group-task" ], "x-mcp-group": [ "Group Task" ], "description": "To delete a task in a group", "operationId": "deleteGroupTask", "parameters": [ { "name": "forceDelete", "in": "query", "description": "To permanently delete the task", "schema": { "type": "boolean" } }, { "name": "taskId", "in": "path", "description": "identifier for task", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "description": "identifier for group", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleteResponseJSON" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.tasks.ALL", "ZohoMail.tasks.DELETE" ] } ] } }, "/api/tasks/me/{taskId}": { "get": { "tags": [ "task" ], "x-mcp-group": [ "Task" ], "description": "To get a single personal task", "operationId": "getPersonalTask", "parameters": [ { "name": "taskId", "in": "path", "description": "identifier for task", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listResponseJSON" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.tasks.ALL", "ZohoMail.tasks.READ" ] } ] }, "put": { "tags": [ "task" ], "x-mcp-group": [ "Task" ], "description": "To edit a task in my tasks", "operationId": "editPersonalTask", "parameters": [ { "name": "taskId", "in": "path", "description": "identifier for task", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Task fields to be updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/editTaskJSON" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responseJSON" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.tasks.ALL", "ZohoMail.tasks.UPDATE" ] } ] }, "delete": { "tags": [ "task" ], "x-mcp-group": [ "Task" ], "description": "To delete a task in my tasks", "operationId": "deletePersonalTask", "parameters": [ { "name": "forceDelete", "in": "query", "description": "To permanently delete the task", "schema": { "type": "boolean" } }, { "name": "taskId", "in": "path", "description": "identifier for task", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleteResponseJSON" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.tasks.ALL", "ZohoMail.tasks.DELETE" ] } ] } }, "/api/tasks/groups/{groupId}": { "get": { "tags": [ "group-task" ], "x-mcp-group": [ "Group Task" ], "description": "To get group tasks", "operationId": "listGroupTask", "parameters": [ { "name": "from", "in": "query", "description": "for paging", "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "no. of tasks needed", "schema": { "type": "integer", "format": "int32" } }, { "name": "groupId", "in": "path", "description": "identifier for group", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listResponseJSON" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.tasks.ALL", "ZohoMail.tasks.READ" ] } ] }, "post": { "tags": [ "group-task" ], "x-mcp-group": [ "Group Task" ], "description": "To add a task in a group", "operationId": "addGroupTask", "parameters": [ { "name": "groupId", "in": "path", "description": "identifier for group", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Task details to create task", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskJSON" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responseJSON" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.tasks.ALL", "ZohoMail.tasks.CREATE" ] } ] } }, "/api/tasks/groups/{groupId}/categories/{categoryId}": { "put": { "tags": [ "category" ], "x-mcp-group": [ "Category" ], "description": "To edit a category in a group", "operationId": "editCategoryInGroupTasks", "parameters": [ { "name": "groupId", "in": "path", "description": "identifier for group", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "categoryId", "in": "path", "description": "identifier for category", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "New name for category to be updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/categoryJSON" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/categorySingleResponseJSON" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.tasks.ALL", "ZohoMail.tasks.UPDATE" ] } ] }, "delete": { "tags": [ "category" ], "x-mcp-group": [ "Category" ], "description": "To delete a category in a group", "operationId": "deleteCategoryInGroupTasks", "parameters": [ { "name": "groupId", "in": "path", "description": "identifier for group", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "categoryId", "in": "path", "description": "identifier for category", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleteResponseJSON" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.tasks.ALL", "ZohoMail.tasks.DELETE" ] } ] } }, "/api/tasks/me": { "get": { "tags": [ "task" ], "x-mcp-group": [ "Task" ], "description": "To get tasks all my personal tasks", "operationId": "listPersonalTasks", "parameters": [ { "name": "from", "in": "query", "description": "for paging", "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "no. of tasks needed", "schema": { "type": "integer", "format": "int32" } }, { "name": "status", "in": "query", "description": "status of the task", "schema": { "type": "string", "enum": [ "In Progress", "Completed" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listResponseJSON" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.tasks.ALL", "ZohoMail.tasks.READ" ] } ] }, "post": { "tags": [ "task" ], "x-mcp-group": [ "Task" ], "description": "To add a task in my tasks", "operationId": "addPersonalTask", "requestBody": { "description": "Task Details to be created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskJSON" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responseJSON" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.tasks.ALL", "ZohoMail.tasks.CREATE" ] } ] } }, "/api/tasks/me/categories": { "get": { "tags": [ "category" ], "x-mcp-group": [ "Category" ], "description": "To get categories in personal tasks", "operationId": "getCategoriesInPersonalTasks", "parameters": [ { "name": "defaultCategory", "in": "query", "description": "is default category details needed in response", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/categoryListResponseJSON" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.tasks.ALL", "ZohoMail.tasks.READ" ] } ] }, "post": { "tags": [ "category" ], "x-mcp-group": [ "Category" ], "description": "To add a category in personal tasks", "operationId": "addCategoriesInPersonalTasks", "requestBody": { "description": "Name for category to be created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/categoryJSON" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/categorySingleResponseJSON" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.tasks.ALL", "ZohoMail.tasks.CREATE" ] } ] } }, "/api/tasks/me/categories/{categoryId}": { "put": { "tags": [ "category" ], "x-mcp-group": [ "Category" ], "description": "To edit a category in personal tasks", "operationId": "editCategoriesInPersonalTasks", "parameters": [ { "name": "categoryId", "in": "path", "description": "identifier for category", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "New name for category to be updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/categoryJSON" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/categorySingleResponseJSON" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.tasks.ALL", "ZohoMail.tasks.UPDATE" ] } ] }, "delete": { "tags": [ "category" ], "x-mcp-group": [ "Category" ], "description": "To delete a category in personal tasks", "operationId": "deleteCategoriesInPersonalTasks", "parameters": [ { "name": "categoryId", "in": "path", "description": "identifier for category", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleteResponseJSON" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.tasks.ALL", "ZohoMail.tasks.DELETE" ] } ] } }, "/api/tasks/groups": { "get": { "tags": [ "group-task" ], "x-mcp-group": [ "Group Task" ], "description": "List of task groups user is a member of", "operationId": "getTaskGroups", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/groupListResponseJSON" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.tasks.ALL", "ZohoMail.tasks.READ" ] } ] } } }, "components": { "securitySchemes": { "iam-oauth2-schema": { "flows": { "authorizationCode": { "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth", "scopes": { "ZohoMail.tasks.ALL": "Full access to Tasks", "ZohoMail.tasks.CREATE": "Write access to Tasks", "ZohoMail.tasks.DELETE": "Delete access to Tasks", "ZohoMail.tasks.READ": "Read access to Tasks", "ZohoMail.tasks.UPDATE": "Update access to Tasks" }, "tokenUrl": "https://accounts.zoho.com/oauth/v2/token" } }, "type": "oauth2" } }, "schemas": { "categoryJSON": { "type": "object", "required": [ "categoryName" ], "properties": { "categoryName": { "type": "string", "description": "name of the category" } } }, "taskJSON": { "type": "object", "properties": { "title": { "type": "string", "description": "name of the task" }, "description": { "type": "string", "description": "summary/description of the task" }, "priority": { "type": "string", "description": "priority of the task, possible values are high, medium, low" }, "status": { "type": "string", "description": "status of the task, possible values are inprogress, completed" }, "assignee": { "type": "integer", "format": "int64", "description": "zuid of the assignee of the task" }, "categoryId": { "type": "string", "description": "specify category of the task" }, "dueDate": { "type": "string", "description": "due date of the task in dd/MM/yyyy format" }, "dueDateTime": { "type": "string", "description": "due time of the task in hr:min format. send along with dueDate" }, "startDate": { "type": "string", "description": "start date of the task in dd/MM/yyyy format. start date cannot be less than due date" }, "startDateTime": { "type": "string", "description": "start time of the task in hr:min format" }, "subtasks": { "type": "array", "description": "subtasks of the task", "items": { "$ref": "#/components/schemas/subTaskJSON", "type": "object" } }, "tagId": { "description": "tag ids that should be applied to the task", "type": "array", "items": { "type": "string" } }, "messageId": { "type": "string", "description": "messageId of the email to be linked to the task. Id can be obtained from the messageId field in the listEmails tool. This is an optional field and can be sent only if the task is being created from an email. Requires accountId parameter while using this field. If accountId is not sent, the task will be created without linking to the email." }, "accountId": { "type": "string", "description": "accountId of the email to be linked to the task. This is an optional field and can be sent only if the task is being created from an email. If accountId is not sent, the task will be created without linking to the email. AccountId can be obtained from the getMailAccounts tool." }, "parentTaskId": { "type": "string", "description": "Id of the parent task if creating a subtask" } } }, "editTaskJSON": { "type": "object", "properties": { "title": { "type": "string", "description": "name of the task" }, "description": { "type": "string", "description": "summary/description of the task" }, "priority": { "type": "string", "description": "priority of the task, possible values are high, medium, low" }, "status": { "type": "string", "description": "status of the task, possible values are inprogress, completed" }, "assignee": { "type": "integer", "format": "int64", "description": "zuid of the assignee of the task" }, "categoryId": { "type": "string", "description": "specify category of the task" }, "dueDate": { "type": "string", "description": "due date of the task in dd/MM/yyyy format" }, "dueDateTime": { "type": "string", "description": "due time of the task in hr:min format. send along with dueDate" }, "startDate": { "type": "string", "description": "start date of the task in dd/MM/yyyy format. start date cannot be less than due date" }, "startDateTime": { "type": "string", "description": "start time of the task in hr:min format" }, "tagId": { "description": "tag ids that should be applied to the task", "type": "array", "items": { "type": "string" } } } }, "listDataJSON": { "properties": { "paging": { "$ref": "#/components/schemas/pagingJSON" }, "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/taskResponseJSON" } } } }, "responseJSON": { "properties": { "status": { "$ref": "#/components/schemas/statusJSON" }, "data": { "$ref": "#/components/schemas/taskResponseJSON" } } }, "pagingJSON": { "properties": { "nextPage": { "type": "string", "description": "URI for next page" } } }, "subTaskJSON": { "properties": { "title": { "type": "string", "description": "name of the task" }, "description": { "type": "string", "description": "summary/description of the task" }, "priority": { "type": "string", "description": "priority of the task, possible values are high, medium, low" }, "status": { "type": "string", "description": "status of the task, possible values are inprogress, completed" }, "dueDate": { "type": "string", "description": "due date of the task in dd/MM/yyyy format" }, "dueDateTime": { "type": "string", "description": "due time of the task in hr:min format. send along with dueDate" }, "startDate": { "type": "string", "description": "start date of the task in dd/MM/yyyy format. start date cannot be less than due date" }, "startDateTime": { "type": "string", "description": "start time of the task in hr:min format" }, "assignee": { "type": "integer", "format": "int64", "description": "zuid of the assignee of the task" } } }, "listResponseJSON": { "properties": { "status": { "$ref": "#/components/schemas/statusJSON" }, "data": { "$ref": "#/components/schemas/listDataJSON" } } }, "categoryListJSON": { "properties": { "categories": { "type": "array", "items": { "$ref": "#/components/schemas/categoryResponseJSON" } } } }, "categoryListResponseJSON": { "properties": { "status": { "$ref": "#/components/schemas/statusJSON" }, "data": { "$ref": "#/components/schemas/categoryListJSON" } } }, "categorySingleResponseJSON": { "properties": { "status": { "$ref": "#/components/schemas/statusJSON" }, "data": { "$ref": "#/components/schemas/categoryResponseJSON" } } }, "statusJSON": { "properties": { "code": { "type": "string", "description": "status code of request" }, "description": { "type": "string", "description": "status message" } } }, "taskResponseJSON": { "properties": { "namespaceId": { "type": "integer", "format": "int64", "description": "Id of the group or user space containing the task" }, "title": { "type": "string", "description": "name of the task" }, "description": { "type": "string", "description": "summary/description of the task" }, "priority": { "type": "string", "description": "priority of the task, possible values are high, medium, low" }, "status": { "type": "string", "description": "status of the task, possible values are inprogress, completed" }, "assignee": { "$ref": "#/components/schemas/userInfoJSON" }, "category": { "$ref": "#/components/schemas/categoryResponseJSON" }, "dueDate": { "type": "string", "description": "due date of the task in dd/MM/yyyy format" }, "parentTaskId": { "type": "string", "description": "Id of the parent task of this task, in case of a subtask" }, "subtasks": { "type": "array", "items": { "$ref": "#/components/schemas/subTaskResponseJSON" } } } }, "userInfoJSON": { "properties": { "id": { "type": "integer", "format": "int64", "description": "zuid of the assignee of the task" }, "name": { "type": "string", "description": "name of the user" } } }, "subTaskResponseJSON": { "properties": { "namespaceId": { "type": "integer", "format": "int64", "description": "Id of the group or user space containing the task" }, "title": { "type": "string", "description": "name of the task" }, "description": { "type": "string", "description": "summary/description of the task" }, "priority": { "type": "string", "description": "priority of the task, possible values are high, medium, low" }, "status": { "type": "string", "description": "status of the task, possible values are inprogress, completed" }, "assignee": { "$ref": "#/components/schemas/userInfoJSON" }, "dueDate": { "type": "string", "description": "due date of the task in dd/MM/yyyy format" } } }, "categoryResponseJSON": { "properties": { "id": { "type": "string", "description": "id of the category" }, "name": { "type": "string", "description": "name of the category" } } }, "deleteResponseJSON": { "properties": { "id": { "type": "string", "description": "id of the deleted resource" } } }, "groupDataJSON" : { "properties": { "id": { "type": "string", "description": "Id of the group" }, "name": { "type": "string", "description": "name of the group" }, "disabled": { "type": "boolean", "description": "status of the group" } } }, "groupListDataJSON" : { "properties": { "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/groupDataJSON" } } } }, "groupListResponseJSON":{ "properties": { "status": { "$ref": "#/components/schemas/statusJSON" }, "data": { "$ref": "#/components/schemas/groupListDataJSON" } } } } } }