Tag 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 from a specific module in an organization.

GET /settings/tags?module={module_api_name}

Request Details

Request URL

http://www.zohoapis.com/bigin/v1/settings/tags?module={module_api_name}

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoBigin.settings.ALL
(or)
scope=ZohoBigin.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 Contacts, Companies, 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

Copiedcurl "https://www.zohoapis.com/bigin/v1/settings/tags?module=Contacts"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

CopiedZBiginModule moduleIns = ZBiginModule.getInstance("Contacts"); //module api name
BulkAPIResponse response = moduleIns.getTags();
List<ZBiginTag> tags = (List<ZBiginTag>) response.getData(); // tags - List of ZBiginTag instances

Copieddef get_tags(self):
        try:
            record = ZBiginModule.get_instance("Contacts")
            response = record.get_tags()
            print(response.status_code)
            tag_ins = response.data
            for tag in tag_ins:
                print(tag.id)
                print(tag.name)
                print("\n\n")
        except ZBiginException as ex:
            print(ex.status_code)
            print(ex.error_message)
            print(ex.error_code)
            print(ex.error_details)
            print(ex.error_content)

Copied/** Get the tags */
$zbiginModuleIns=ZBiginModule::getInstance("Contacts");
$bulkAPIResponse = $zbiginModuleIns->getTags();
$tagsArray=$bulkAPIResponse->getData(); // $tagsArray - array of ZBiginTag instances

CopiedZBiginModule moduleIns = ZBiginModule.GetInstance("Contacts"); //module api name
BulkAPIResponse<ZBiginTag> response = moduleIns.GetTags();
List<ZBiginTag> tags = response.BulkData; // tags - List of ZBiginTag instances

Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/bigin/v1/settings/tags?module=Contacts"
	type: GET
	connection:"bigin_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.

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 ZohoBigin.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_by": {
                "id": "2000000030444",
                "name": "Construction Industry"
            },
            "created_time": "2017-03-24T11:08:23+05:30",
            "id": "2000000039007",
            "modified_by": {
                "id": "2000000030444",
                "name": "Chems"
            },
            "modified_time": "2017-03-24T11:08:23+05:30",
            "name": "Chemical Industry"
        }
    ],
    "info": {
        "allowed_count": 50,
        "count": 1
    }
}