GET - Get All Tasks in a Group with a Given Status

Purpose

This API is used to retrieve all tasks in a specific group with the specified status (either completed or inprogress), 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 tasks in a group with the specified status.

Request URL

Method: GET

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

Path Parameters

  • zgid* long
    • Specifies the status of completion of the task.
    • This parameter can be retrieved from the Get all groups API.

Query Parameters

  • status* string
    • Specifies the status of completion of the task.
    • Possible values : 
      • inprogress
      • completed
  • limit integer
    • Specifies the number of tasks that you would like 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

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

Sample Response

Copied{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": {
    "paging": {
      "nextPage": "/api/tasks/groups/53658048?from=1&limit=1&status=inprogress"
    },
    "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": "Blog Updates",
        "priority": "Normal",
        "tags": [],
        "createdAt": "2018-10-30T15:14:10+05:30",
        "followers": [],
        "namespaceId": "53658048",
        "id": "17461000000053006",
        "assignee": "Justin Case",
        "status": "In Progress"
      }
    ]
  }
}