GET - Get All Tasks in a Group/Personal Tasks

Purpose

This API is used to retrieve all your personal tasks or all the tasks in a particular group, providing details for each task such as its ID, title, description, due date, owner, assignee, priority, status, project name, and ID under which it falls, as well as subtasks and attachment details if available.

OAuth Scope

Use the scope

ZohoMail.tasks.ALL (or) ZohoMail.tasks.READ

to generate the Authtoken.

ALL - Full access to tasks.

READ - Retrieve all the personal tasks/ all the tasks in a group.

Request URL

Method: GET

Group task:

https://mail.zoho.com/api/tasks/groups/{zgid}

Personal task:

https://mail.zoho.com/api/tasks/me

Query Parameters

  • limit integer
    • Specifies the number of tasks to retrieve.
    • Possible values : (1 - 499)
    • Default value : 20
  • from integer
    • Specifies the task number from which retrieval has to be done. e.g.: If you want to retrieve tasks starting from the 50th task to the 70th task, the 'from' value should be 50, and the 'limit' value should be 20.
    • Possible values : (0 - Number of tasks available).
    • Default value : 0

 

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request - Group Tasks

Copiedcurl "https://mail.zoho.com/api/tasks/groups/5365*****?from=2&limit=1" \
-X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"

Sample Request - Personal Tasks

Copiedcurl "https://mail.zoho.com/api/tasks/me?limit=1&from=1" \
-X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****" \

Sample Response - Group Tasks

Copied{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": {
    "paging": {
      "nextPage": "/api/tasks/groups/5365*****?from=2&limit=1"
    },
    "tasks": [
      {
        "owner": {
          "name": "Rebecca",
          "id": 53608806
        },
        "numberOfSubtasks": 0,
        "modifiedTime": "2018-10-30T15:14:10+05:30",
        "attachments": [],
        "subtasks": [],
        "description": "",
        "project": {
          "name": "General",
          "id": "17461000000006001"
        },
        "title": "Marketing Collaterals",
        "priority": "Normal",
        "tags": [],
        "createdAt": "2018-10-30T15:14:10+05:30",
        "followers": [],
        "namespaceId": "53658048",
        "id": "17461000000053006",
        "assignee": null,
        "status": "In Progress"
      }
    ]
  }
}

Sample Response - Personal Tasks

Copied{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": {
    "paging": {
      "nextPage": "/api/tasks/me?from=1&limit=1"
    },
    "tasks": [
      {
        "owner": {
          "name": "Rebecca",
          "id": 42522589
        },
        "numberOfSubtasks": 0,
        "modifiedTime": "2018-10-30T15:36:27+05:30",
        "attachments": [],
        "subtasks": [],
        "dueDate": "30/10/2018",
        "description": "Blog posts and announcements for the release",
        "project": {
          "name": "Blogging",
          "id": "4497000000053001"
        },
        "title": "Revamp Announcements",
        "priority": "Normal",
        "tags": [],
        "createdAt": "2018-10-25T13:36:51+05:30",
        "followers": [],
        "namespaceId": "42522589",
        "id": "4497000001134001",
        "assignee": {
          "name": "Paula M",
          "id": 42522589
        },
        "status": "In Progress"
      }
    ]
  }
}