Get a Specific Label Details

Purpose

This API retrieves the details of a specific label based on the Account ID and the Label ID provided in the request. 

OAuth Scope

Use the scope

ZohoMail.tags.ALL (or) ZohoMail.tags.READ

to generate the Authtoken.

ALL - Full access to tags.

READ - Provides access to read tags.

Request URL

Method : GET

https://mail.zoho.com/api/accounts/{accountId}/labels/{labelId}

Path Parameters

  • accountIdlong
    • This parameter is used to identify the account whose details are retrieved.
    • This parameter can be retrieved from the Get User Account Details API.
  • labelIdlong
    • This parameter is used to identify the label whose details are retrieved.
    • This parameter can be retrieved from the Get All Label Details API.

 

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request

Copiedcurl "https://mail.zoho.com/api/accounts/12345678/label/2674552000000009029" \
-X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"

Sample Response

Copied{
"status": {
"code": 200,
"description": "success"
},
"data": {
"sequence": 2,
"labelId": "2674552000000009029",
"color": "#96ccf5",
"tagId": "2674552000000009029",
"displayName": "hello",
"URI": "https://mail.zoho.com/api/accounts/12345678/labels/2674552000000009029"
}
}