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 in an organization.
Request URL
https://recruit.zoho.com/recruit/v2/settings/tags?module={module_api_name}
module_api_name - The API name of the module
Request Method
GET
Scope
scope=ZohoRECRUIT.settings.all
(or)
scope=ZohoRECRUIT.settings.tags.all
(or)
scope=ZohoRECRUIT.settings.tags.read
Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| module (mandatory) | String | Specify the API name of the module such as Candidates, Job Openings, Interviews, etc,. |
| my_tags (optional) | String | Displays the names of the tags created by the current user. |
Attributes
"allowed_count" represents the number of tags that can be created in the current edition.
"count" represents the total number of tags created.
Sample Request
Copiedcurl "https://recruit.zoho.com/recruit/v2/settings/tags?module=Candidates"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"Sample Response
Copied{
"data": {
"tags": [{
"color_code": "#F48435",
"created_time": "2020-08-22T19:49:38+05:30",
"modified_time": "2020-08-22T19:49:38+05:30",
"modified_by": {
"name": "Patricia Boyle",
"id": "486812000000216003"
},
"name": "India",
"id": 486812000001659015,
"created_by": {
"name": "Patricia Boyle",
"id": "486812000000216003"
}
},
{
"color_code": "#F48435",
"created_time": "2020-08-22T19:50:05+05:30",
"modified_time": "2020-08-22T19:50:05+05:30",
"modified_by": {
"name": "Patricia Boyle",
"id": "486812000000216003"
},
"name": "New",
"id": 486812000001659023,
"created_by": {
"name": "Patricia Boyle",
"id": "486812000000216003"
}
}
]
}
}
