Tags APIs

Tags are keywords that help you categorize your records based on their characteristics. Tags help you sort your data and find them easily when you need them.

Get Tags

Purpose

To display all the tags in an organization.

Endpoints

Request Details

Request URL

{api-domain}/crm/{version}/settings/tags?module={module_api_name}

Supported modules

Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, and Custom.

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.settings.ALL
(or)
scope=ZohoCRM.settings.tags.{operation_type}

Possible operation types

ALL - Full access to tags
READ - Get tag details

Parameters

  • modulestring, mandatory

    Specify the API name of the module such as Leads, Accounts, Deals, etc,.

  • my_tagsboolean, optional

    The value true displays the names of the tags created by the current user. The default value is false.

Sample Request

CurlDeluge
Copiedcurl "https://www.zohoapis.com/crm/v6/settings/tags?module=Leads"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/crm/v6/settings/tags?module=Leads"
	type: GET
	connection:"crm_oauth_connection"
];
info response;

Response JSON keys

  • created_timestring

    Represents the date and time at which the tag was created.

  • modified_timestring

    Represents the date and time at which the tag was last modified.

  • namestring

    Represents the name of the current tag.

  • modified_byJSON object

    Represents the name and ID of the user who last modified the current tag.

  • idstring

    Represents the unique ID of the current tag.

  • created_byJSON object

    Represents the name and ID of the user who created the tag.

  • colour_codestring

    Represents the hex color code of the tag.

Possible Errors

  • INVALID_MODULEHTTP 400

    The module name given seems to be invalid
    Resolution: You have specified an invalid module name or there is no tab permission, or the module could have been removed from the available modules. Specify a valid module API name.

  • INVALID_MODULEHTTP 400

    The given module is not supported in API
    Resolution: The modules such as Documents and Projects are not supported in the current API. (This error will not be shown, once these modules are been supported). Specify a valid module API name.

  • INVALID_URL_PATTERNHTTP 404

    Please check if the URL trying to access is a correct one
    Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    Unauthorized
    Resolution: Client does not have ZohoCRM.settings.tags.READ scope. Create a new client with valid scope. Refer to scope section above.

  • NO_PERMISSIONHTTP 403

    Permission denied to read tag details
    Resolution: The user does not have permission to read tag details. Contact your system administrator.

  • INTERNAL_ERRORHTTP 500

    Internal Server Error
    Resolution: Unexpected and unhandled exception in Server. Contact support team.

  • INVALID_REQUEST_METHODHTTP 400

    The http request method type is not a valid one
    Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above.

  • AUTHORIZATION_FAILEDHTTP 400

    User does not have sufficient privilege to read tag details
    Resolution: The user does not have the permission to read tag details. Contact your system administrator.

  • REQUIRED_PARAM_MISSINGHTTP 400

    One of the expected parameter is missing
    Resolution: 'module' parameter is missing in the request. Please specify the API name of the module. Refer to Modules API to get valid module API names.

Sample Response

Copied{
    "tags": [
        {
            "created_time": "2018-12-28T16:49:07+05:30",
            "modified_time": "2019-02-18T23:17:47+05:30",
            "name": "Pharma",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "id": "3652397000000371014",
            "created_by": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "color_code": “#57B1FD”
        },
        {
            "created_time": "2018-12-28T16:49:07+05:30",
            "modified_time": "2019-02-18T23:15:51+05:30",
            "name": "Agricultural",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "id": "3652397000000371015",
            "created_by": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "color_code": null
        },
        {
            "created_time": "2021-03-01T15:26:47+05:30",
            "modified_time": "2021-03-01T15:26:47+05:30",
            "name": "Agro",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "id": "3652397000003983010",
            "created_by": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "color_code": null
        },
        {
            "created_time": "2021-03-01T15:26:58+05:30",
            "modified_time": "2021-03-01T15:26:58+05:30",
            "name": "Chem",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "id": "3652397000003983017",
            "created_by": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "color_code": null
        },
        {
            "created_time": "2021-10-22T13:08:29+05:30",
            "modified_time": "2021-10-22T13:08:29+05:30",
            "name": "Nurturing Lead",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "id": "3652397000005752002",
            "created_by": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "color_code": null
        },
        {
            "created_time": "2022-03-01T09:25:55+05:30",
            "modified_time": "2022-03-01T09:25:55+05:30",
            "name": "Nurture1",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "id": "3652397000007430004",
            "created_by": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "color_code": "#57B1FD"
        }
    ],
    "info": {
        "count": 6,
        "allowed_count": 200
    }
}