Tasks API
The Tasks API facilitates the retrieval of tasks assigned to you, tasks added to a group, and enables task addition and management, etc.
While using any API related to tasks, make use of the OAuth scope ZohoMail.tasks.
Method Name | URL | Method Type | OAuth Scope | Purpose |
Add a new group or personal task | Group tasks: /api/tasks/groups/{zgid} | POST | ZohoMail.tasks | To add a new group/personal task. |
Personal tasks: /api/tasks/me | ||||
Add a new project | /api/tasks/groups/{zgid}/projects | POST | To add a new project. | |
Get all tasks in a group or all personal tasks | Group tasks: /api/tasks/groups/{zgid} | GET | To get all the tasks added to a group or your personal tasks. | |
Personal tasks: /api/tasks/me | ||||
Get all tasks assigned to you | /api/tasks | GET | To get all the tasks assigned to you. | |
Get all tasks created by you | /api/tasks | GET | To get all the tasks created by you. | |
Get a specific task | Group tasks: /api/tasks/groups/{zgid}/{taskId} | GET | To get a particular task's details. | |
Personal tasks: /api/tasks/me/{taskId} | ||||
Get all subtasks under a task | Group tasks: /api/tasks/groups/{zgid}/{taskId}/subtasks | GET | To get all subtasks under a specific task. | |
Personal tasks: /api/tasks/me/{taskId}/subtasks | ||||
Get all projects in a group | /api/tasks/groups/{zgid}/projects | GET | Get all the projects created in a group. | |
Get all tasks in a project | /api/tasks/groups/{zgid}/projects/{projectId} | GET | To get all tasks under a specific project. | |
Get all tasks in a project with given status | /api/tasks/groups/{zgid}/projects/{projectId} | GET | To get all tasks in a project with the specified status. | |
Get all groups | /api/tasks/groups | GET | Get all the group details. | |
Get all tasks in a group with given status | /api/tasks/groups/{zgid} | GET | To get all tasks with the specified status. | |
Get member details in a group | /api/tasks/groups/{zgid}/members | GET | Get the details of all members in a group. | |
Change task title | Group tasks: /api/tasks/groups/{zgid}/{taskId} | PUT | To change the title of a task. | |
Personal tasks: /api/tasks/me/{taskId} | ||||
Change task description | Group tasks: /api/tasks/groups/{zgid}/{taskId} | PUT | To change the description of a task. | |
Personal tasks: /api/tasks/me/{taskId} | ||||
Change task priority | Group tasks: /api/tasks/groups/{zgid}/{taskId} | PUT | To change the priority of a task. | |
Personal tasks: /api/tasks/me/{taskId} | ||||
Change task status | Group tasks: /api/tasks/groups/{zgid}/{taskId} | PUT | To change the status of a task. | |
Personal tasks: /api/tasks/me/{taskId} | ||||
Change task project | Group tasks: /api/tasks/groups/{zgid}/{taskId} | PUT | To change the project under which a task is added. | |
Personal tasks: /api/tasks/me/{taskId} | ||||
Change task assignee | Group tasks: /api/tasks/groups/{zgid}/{taskId} | PUT | To change the member to whom the task is assigned. | |
Personal tasks: /api/tasks/me/{taskId} | ||||
Set/ change task due date | Group tasks: /api/tasks/groups/{zgid}/{taskId} | PUT | To set or change the due date of a task. | |
Personal tasks: /api/tasks/me/{taskId} | ||||
Set/ change task reminder | Group tasks: /api/tasks/groups/{zgid}/{taskId} | PUT | To set or change the reminding date for a task. | |
Personal tasks: /api/tasks/me/{taskId} | ||||
Set/ change task reminder based on due date | Group tasks: /api/tasks/groups/{zgid}/{taskId} | PUT | To set or change the reminding date few days prior to the due date. | |
Personal tasks: /api/tasks/me/{taskId} | ||||
Set/ change recurring task | Group tasks: /api/tasks/groups/{zgid}/{taskId} | PUT | To set or change the recurrence pattern of the task. | |
Personal tasks: /api/tasks/me/{taskId} | ||||
Edit a project | /api/tasks/groups/{zgid}/projects/{projectId} | PUT | Edit the name of a project. | |
Delete a project | /api/tasks/groups/{zgid}/projects/{projectId} | DELETE | Delete a project. | |
Delete a group/personal task | Group tasks: /api/tasks/groups/{zgid}/{taskId} | DELETE | Delete a task from a group or a personal task. | |
Personal tasks: /api/tasks/me/{taskId} |