GET - Get Custom Status of a Group/Personal Task

Purpose

This API retrieves the custom status associated with a personal task or a group task.

OAuth Scope

Use the scope

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

to generate the Authtoken.

ALL - Full access to tasks.

READ - Read the custom status of tasks.

Request URL

Method: GET

Group Task:

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

Personal Task:

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

Path Parameters

  • zgidlong
    • Specifies the unique identifier used for groups in an organization.
    • This parameter can be retrieved from the Get all groups API.

 

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request - Group Task

Copiedcurl "https://mail.zoho.com/api/tasks/groups/116005836/customStatus" \
-X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken **************" 

Sample Response - Group Task

Copied{
    "status": {
        "code": 200,
        "description": "success"
    },
    "data": [
        {
            "statusColour": "#FDAD65",
            "statusId": "11",
            "statusName": "s2",
            "statusposition": "3"
        },
        {
            "statusColour": "#ED3D88",
            "statusId": "10",
            "statusName": "s1"
        }
    ]
}