Retrieve tags
You can retrieve tags created in the application using the API.
Request
GET /company/{companyID}/tags
Parameters
| Parameter | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
| companyID | path | string | Company identifier | Wy3EOp2NP3p1KMq8 |
Request example
cURL request
curl -X GET https://api.flatchr.io/company/Wy3EOp2NP3p1KMq8/tags
-H "Authorization: Bearer {token}"
-H 'Content-Type: application/json'
Response
| Name | Type | Description |
|---|---|---|
| id | string | Tag identifier |
| tag_id | integer | Plain tag identifier |
| company_id | integer | Plain company identifier |
| title | string | Tag title |
| values | string | Possible tag values (separated by ;) |
| multiple | boolean | Whether the tag can have multiple values |
| visible | boolean | Whether the tag is visible by default on the candidate profile |
| creatable | boolean | Whether new values can be created for the tag |
| folder | boolean | Whether the tag is used as a folder |
| type | string | candidates for candidate tags or vacancies for listing tags |
| position | integer | Tag position in the list |
Response example
[{
"id": "7jKJ0Mpz60pXNgxa",
"tag_id": 1174,
"company_id": 99,
"title": "IT Department",
"values": "",
"multiple": false,
"visible": false,
"creatable": false,
"folder": true,
"type": "vacancies",
"position": null,
"tagCandidateRestriction": []
}, {
"id": "vADYjo9mwOdkR0ry",
"tag_id": 1178,
"company_id": 99,
"title": "Languages",
"values": "French;English;Spanish;German;Italian;Chinese",
"multiple": true,
"visible": true,
"creatable": false,
"folder": false,
"type": "candidates",
"position": null,
"tagCandidateRestriction": []
}, {
"id": "5gQayv9L1Qp6LXE4",
"tag_id": 1183,
"company_id": 99,
"title": "Degree",
"values": "High School;Associate;Bachelor;Master",
"multiple": false,
"visible": true,
"creatable": false,
"folder": false,
"type": "candidates",
"position": null,
"tagCandidateRestriction": []
}]