> This page is for API, version 2026-01-01 (Stable) (default). > For other versions, use one of these documentation indexes: > - 2026-01-01 (Stable) (default): https://docs.deel.wtf/api/stable/llms.txt > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.deel.wtf/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.deel.wtf/_mcp/server. # List candidate tags of the organization GET https://api.letsdeel.com/rest/ats/tags Lists the candidate tags of the organization. Use it to find tag ids before setting the tags of a candidate with `POST /rest/ats/candidates/{candidate_id}/tags` or filtering candidates by tag with `GET /rest/ats/candidates`. **Token scopes**: `ats:read`, `worker:read` Reference: https://docs.deel.wtf/api/ats-endpoints/ats-tags/list-tags-v-2026-02-27 ## Authentication - `Authorization` header (bearer token, required) — ## Authentication The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail. ```curl curl -X GET 'https://api.deel.training/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication) - `Authorization` header (bearer token, required) — Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/ ## Servers - `https://api.letsdeel.com/rest` (Production, default) - `https://api-staging.letsdeel.com/rest` (Demo) ## Request ### Query parameters - `search_text` (string, optional) — Filter tags by label (case-insensitive partial match) - `tag_group_slug` (enum, optional) — Filter by tag group. Use CANDIDATE for candidate tags. - Allowed values: `CANDIDATE` - `include_archived` (string, optional) — If true, archived tags are included in the response; they are excluded by default. - `include_counts` (enum, optional, default: false) — When true, each tag includes candidates_count (number of candidates with that tag) - Allowed values: `true`, `false` - `cursor` (string, optional) — Opaque cursor for pagination. Use the value from next_cursor of the previous response to fetch the next page. - `limit` (integer, optional, default: 20) — Maximum number of tags to return per page (default: 20, max: 100). ## Response ### 200 Successful operation. Returns the list of tags for the organization. - `data` (list of AtsTagsGetResponsesContentApplicationJsonSchemaDataItems, required) — List of tags. - `has_more` (boolean, required) — Whether more results exist (pagination). - `next_cursor` (string, required, nullable) — Cursor for the next page of results, or null if none. - `total_count` (integer, required) — Total number of tags returned. ## Errors ### 400 Bad Request Error Operation failed. - `errors` (list of AtsTagsGetResponsesContentApplicationJsonSchemaErrorsItems, required) — List of error objects ### 401 Unauthorized Error Operation failed. - `request` (ApiErrorRequest, optional) - `errors` (list of ApiError, optional) ### 403 Forbidden Error Forbidden. ATS is not enabled for this organization or insufficient permissions. - `errors` (list of AtsTagsGetResponsesContentApplicationJsonSchemaErrorsItems, required) — List of error objects ### 404 Not Found Error Operation failed. - `request` (ApiErrorRequest, optional) - `errors` (list of ApiError, optional) ### 500 Internal Server Error Operation failed. - `errors` (list of AtsTagsGetResponsesContentApplicationJsonSchemaErrorsItems, required) — List of error objects ## Types ### AtsTagsGetResponsesContentApplicationJsonSchemaDataItems - `id` (string, required) — Unique identifier of the tag. - `created_at` (string, required) — When the tag was created. - `updated_at` (string, required) — When the tag was last updated. - `label` (string, optional) — Display name of the tag. - `archived_at` (string, optional, nullable) — When the tag was archived; null while the tag is active and selectable. - `tag_group_slug` (enum, optional) — Tag group. Use CANDIDATE for candidate tags. - Allowed values: `CANDIDATE` - `candidates_count` (integer, optional, nullable) — Number of candidates with this tag. Present only when include_counts=true. - `created_by_hris_organization_user_id` (string, optional, nullable) — ID of the user who created the tag, if any. - `updated_by_hris_organization_user_id` (string, optional, nullable) — ID of the user who last updated the tag, if any. ### AtsTagsGetResponsesContentApplicationJsonSchemaErrorsItems - `code` (string, required) — Machine-readable error code - `message` (string, required) — Human-readable error message - `field` (string, optional) — Request field related to the error, if applicable ### ApiErrorRequest - `method` (string, optional) — The HTTP method of the failed request - `url` (string, optional) — The relative URL of the failed request - `status` (double, optional) — The status code of the response - `api_req_id` (string, optional) — The request ID of the failed request - `docs` (string, optional) — A link to the official documentation for the requested endpoint resource - `source` (string, optional) — The source handler which produced the returned error - `code` (double, optional) — The code of the source handler which produced the returned error ### ApiError - `message` (string, optional) — A description of the returned error - `path` (string, optional) — The JSON path where input validation failed ## Examples **Response** ```json { "data": [ { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "created_at": "2026-02-26T12:00:00.000Z", "updated_at": "2026-02-26T12:00:00.000Z", "label": "Referral", "archived_at": "2026-09-03T10:24:11.512Z", "tag_group_slug": "CANDIDATE", "candidates_count": 5, "created_by_hris_organization_user_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "updated_by_hris_organization_user_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" } ], "has_more": false, "next_cursor": "eyJwYWdlIjoyfQ==", "total_count": 10 } ``` **SDK Code** ```python import requests url = "https://api.letsdeel.com/rest/ats/tags" querystring = {"cursor":"eyJwYWdlIjoyfQ==","include_archived":"true","include_counts":"false","limit":"20","search_text":"Referral","tag_group_slug":"CANDIDATE"} headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript const url = 'https://api.letsdeel.com/rest/ats/tags?cursor=eyJwYWdlIjoyfQ%3D%3D&include_archived=true&include_counts=false&limit=20&search_text=Referral&tag_group_slug=CANDIDATE'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.letsdeel.com/rest/ats/tags?cursor=eyJwYWdlIjoyfQ%3D%3D&include_archived=true&include_counts=false&limit=20&search_text=Referral&tag_group_slug=CANDIDATE" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.letsdeel.com/rest/ats/tags?cursor=eyJwYWdlIjoyfQ%3D%3D&include_archived=true&include_counts=false&limit=20&search_text=Referral&tag_group_slug=CANDIDATE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.letsdeel.com/rest/ats/tags?cursor=eyJwYWdlIjoyfQ%3D%3D&include_archived=true&include_counts=false&limit=20&search_text=Referral&tag_group_slug=CANDIDATE") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api.letsdeel.com/rest/ats/tags?cursor=eyJwYWdlIjoyfQ%3D%3D&include_archived=true&include_counts=false&limit=20&search_text=Referral&tag_group_slug=CANDIDATE', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.letsdeel.com/rest/ats/tags?cursor=eyJwYWdlIjoyfQ%3D%3D&include_archived=true&include_counts=false&limit=20&search_text=Referral&tag_group_slug=CANDIDATE"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.letsdeel.com/rest/ats/tags?cursor=eyJwYWdlIjoyfQ%3D%3D&include_archived=true&include_counts=false&limit=20&search_text=Referral&tag_group_slug=CANDIDATE")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```