Tags
Overview
Tags are keywords that help in categorizing your records based on their characteristics. The essential purpose of a tag is to help you organize, sort, and locate your records efficiently whenever needed.
Endpoints
Get tags
Retrieves the list of available tags from a specific module in an organization.
Request URL
{api-domain}/bigin/v2/settings/tags?module={module_api_name}
Choose domain-specific URL to replace {api-domain}
You can use the domain-specific URL to access Bigin resources. Based on the data center in which the Bigin account's resources are available, replace {api-domain} in the preceding request with one of the following API domain URLs:
- For US, https://www.zohoapis.com
- For EU, https://www.zohoapis.eu
- For AU, https://www.zohoapis.com.au
- For IN, https://www.zohoapis.in
- For CN, https://www.zohoapis.com.cn
- For JP, https://www.zohoapis.jp
For more information, see Multi DC Support.
Authorization
For this endpoint, pass the access token as an authorization header. See OAuth Authentication for more information about access tokens.
Authorization: Zoho-oauthtoken <ACCESS_TOKEN>
You must authenticate using an access token that is associated with one of the following scopes:
- ZohoBigin.settings.ALL
- ZohoBigin.settings.tags.ALL
- ZohoBigin.settings.tags.READ
Request parameters
The available request parameters are given below:
Query parameters
module stringRequired
The API name of the module. The possible modules for this endpoint and their API name are given below:
| Module | API Name |
|---|---|
| Contacts | Contacts |
| Pipelines | Pipelines |
| Companies | Accounts |
| Products | Products |
| Tasks | Tasks |
| Events | Events |
| Calls | Calls |
my_tags booleanOptional
Provide the value true to retrieve the tags created by the current user. The default value is false.
Sample request
Copiedcurl "https://www.zohoapis.com/bigin/v2/settings/tags?module=Pipelines" \
-X GET \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"Copiedresponse = invokeurl
[
url: "https://www.zohoapis.com/bigin/v2/settings/tags?module=Pipelines"
type: GET
connection:"connection_link_name"
];
info response;Response object
The response object contains the following details:
created_time datetime
The date and time when the tag was created.
modified_time datetime
The date and time of the last modification of the tag.
name string
The name of the tag.
modified_by jsonobject
The user details who have done the most recent modification of the tag.
id string
The unique identification of the tag.
created_by jsonobject
The user details who have created the tag.
color_code string
The color code of the tag.
Possible error codes
The response of this resource includes HTTP status and error codes.
The most common HTTP error codes that occur when you request access to this endpoint are given in the following:
- 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_time": "2023-04-11T17:00:37+05:30",
"modified_time": "2023-04-11T17:00:37+05:30",
"name": "Hot",
"modified_by": {
"name": "Zylker Travels",
"id": "2034020000000457001"
},
"id": "2034020000000459531",
"created_by": {
"name": "Zylker Travels",
"id": "2034020000000457001"
},
"color_code": null
},
{
"created_time": "2023-04-24T15:56:19+05:30",
"modified_time": "2023-04-24T15:56:19+05:30",
"name": "VacationPackages",
"modified_by": {
"name": "Zylker Travels",
"id": "2034020000000457001"
},
"id": "2034020000000504123",
"created_by": {
"name": "Zylker Travels",
"id": "2034020000000457001"
},
"color_code": "#BEEAE8"
},
{
"created_time": "2023-04-24T15:58:04+05:30",
"modified_time": "2023-04-24T15:58:04+05:30",
"name": "TravelDeal",
"modified_by": {
"name": "Zylker Travels",
"id": "2034020000000457001"
},
"id": "2034020000000504137",
"created_by": {
"name": "Zylker Travels",
"id": "2034020000000457001"
},
"color_code": "#D0D9E2"
},
{
"created_time": "2023-04-24T16:04:27+05:30",
"modified_time": "2023-04-24T16:04:27+05:30",
"name": "AdventureDeal",
"modified_by": {
"name": "Zylker Travels",
"id": "2034020000000457001"
},
"id": "2034020000000504156",
"created_by": {
"name": "Zylker Travels",
"id": "2034020000000457001"
},
"color_code": "#FDD399"
}
],
"info": {
"count": 4,
"allowed_count": 30
}
}