> 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://developer.deel.com/api/stable/llms.txt > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developer.deel.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.deel.com/_mcp/server. # Retrieve suggested ATS email templates GET https://api.letsdeel.com/rest/ats/email-template-suggestions Returns the email templates the authenticated user sends most often, and the templates the organization sends most at a given application stage, to help pick a template before drafting an email. **Token scopes**: `ats:read`, `worker:read` **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-01-28. Reference: https://developer.deel.com/api/reference/endpoints/ats/retrieve-ats-email-template-suggestions-v-2026-10-28 ## 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.letsdeel.com/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 - `application_id` (string, optional) — Suggest templates for this application's current stage. Takes precedence over interview_plan_stage_id. - `interview_plan_stage_id` (string, optional) — Suggest templates for this interview plan stage. ### Headers - `X-Beta` (enum, required, default: true) — Opts in to the beta version of this endpoint. Must be `true`. - Allowed values: `true` ## Response ### 200 Suggested email templates - `data` (AtsEmailTemplateSuggestionsGetResponsesContentApplicationJsonSchemaData, required) ## Errors ### 400 Bad Request Error Operation failed. - `errors` (list of AtsEmailTemplateSuggestionsGetResponsesContentApplicationJsonSchemaErrorsItems, 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 AtsEmailTemplateSuggestionsGetResponsesContentApplicationJsonSchemaErrorsItems, 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 AtsEmailTemplateSuggestionsGetResponsesContentApplicationJsonSchemaErrorsItems, required) — List of error objects ## Types ### AtsEmailTemplateSuggestionsGetResponsesContentApplicationJsonSchemaData - `frequently_used` (list of AtsEmailTemplateSuggestionsGetResponsesContentApplicationJsonSchemaDataFrequentlyUsedItems, required) — Templates the authenticated user sent most often recently, most used first. - `stage_suggestions` (AtsEmailTemplateSuggestionsGetResponsesContentApplicationJsonSchemaDataStageSuggestions, required, nullable) — Templates the organization sends most at the requested stage. Null when no stage was given or the stage has too little send history to suggest from. ### AtsEmailTemplateSuggestionsGetResponsesContentApplicationJsonSchemaErrorsItems - `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 ### AtsEmailTemplateSuggestionsGetResponsesContentApplicationJsonSchemaDataFrequentlyUsedItems - `send_count` (integer, required) — How many times the template was sent in the trailing window - `email_template` (AtsEmailTemplateSuggestionsGetResponsesContentApplicationJsonSchemaDataFrequentlyUsedItemsEmailTemplate, required) ### AtsEmailTemplateSuggestionsGetResponsesContentApplicationJsonSchemaDataStageSuggestions Templates the organization sends most at the requested stage. Null when no stage was given or the stage has too little send history to suggest from. - `items` (list of AtsEmailTemplateSuggestionsGetResponsesContentApplicationJsonSchemaDataStageSuggestionsItemsItems, required) — Suggested templates, most used first. - `stage_name` (string, required) — Customer-defined stage name ### AtsEmailTemplateSuggestionsGetResponsesContentApplicationJsonSchemaDataFrequentlyUsedItemsEmailTemplate - `id` (string, required) — Email template ID - `body` (string, required) — Email body as HTML with \$\{\{token}} placeholders - `type` (enum, required) — Template type - Allowed values: `CUSTOM`, `DEFAULT_APPLICATION_CONFIRMATION`, `DEFAULT_ARCHIVE`, `DEFAULT_OFFER`, `DEFAULT_CANDIDATE_INTERVIEW_SCHEDULING`, `DEFAULT_QUESTIONNAIRE`, `DEFAULT_REFERRAL_CONFIRMATION`, `DEFAULT_DOCUMENT`, `DEFAULT_INTERVIEW_SCHEDULED_CANDIDATE`, `DEFAULT_INTERVIEW_SCHEDULED_INTERVIEWERS`, `DEFAULT_INTERVIEW_SCHEDULED_RECRUITERS`, `DEFAULT_INTERVIEW_RESCHEDULED_CANDIDATE`, `DEFAULT_INTERVIEW_RESCHEDULED_INTERVIEWERS`, `DEFAULT_INTERVIEW_RESCHEDULED_RECRUITERS`, `DEFAULT_INTERVIEW_CANCELLED_CANDIDATE`, `DEFAULT_INTERVIEW_CANCELLED_INTERVIEWERS`, `DEFAULT_INTERVIEW_CANCELLED_RECRUITERS`, `DEFAULT_INTERVIEWER_ADDED`, `DEFAULT_INTERVIEWER_REMOVED`, `DEFAULT_INTERVIEWERS_CHANGED_RECRUITERS`, `DEFAULT_INTERVIEW_RESCHEDULE_REQUEST_CANDIDATE` - `title` (string, required) — Email template title - `subject` (string, required) — Email subject with \$\{\{token}} placeholders ### AtsEmailTemplateSuggestionsGetResponsesContentApplicationJsonSchemaDataStageSuggestionsItemsItems - `send_count` (integer, required) — How many times the template was sent in the trailing window - `email_template` (AtsEmailTemplateSuggestionsGetResponsesContentApplicationJsonSchemaDataStageSuggestionsItemsItemsEmailTemplate, required) ### AtsEmailTemplateSuggestionsGetResponsesContentApplicationJsonSchemaDataStageSuggestionsItemsItemsEmailTemplate - `id` (string, required) — Email template ID - `body` (string, required) — Email body as HTML with \$\{\{token}} placeholders - `type` (enum, required) — Template type - Allowed values: `CUSTOM`, `DEFAULT_APPLICATION_CONFIRMATION`, `DEFAULT_ARCHIVE`, `DEFAULT_OFFER`, `DEFAULT_CANDIDATE_INTERVIEW_SCHEDULING`, `DEFAULT_QUESTIONNAIRE`, `DEFAULT_REFERRAL_CONFIRMATION`, `DEFAULT_DOCUMENT`, `DEFAULT_INTERVIEW_SCHEDULED_CANDIDATE`, `DEFAULT_INTERVIEW_SCHEDULED_INTERVIEWERS`, `DEFAULT_INTERVIEW_SCHEDULED_RECRUITERS`, `DEFAULT_INTERVIEW_RESCHEDULED_CANDIDATE`, `DEFAULT_INTERVIEW_RESCHEDULED_INTERVIEWERS`, `DEFAULT_INTERVIEW_RESCHEDULED_RECRUITERS`, `DEFAULT_INTERVIEW_CANCELLED_CANDIDATE`, `DEFAULT_INTERVIEW_CANCELLED_INTERVIEWERS`, `DEFAULT_INTERVIEW_CANCELLED_RECRUITERS`, `DEFAULT_INTERVIEWER_ADDED`, `DEFAULT_INTERVIEWER_REMOVED`, `DEFAULT_INTERVIEWERS_CHANGED_RECRUITERS`, `DEFAULT_INTERVIEW_RESCHEDULE_REQUEST_CANDIDATE` - `title` (string, required) — Email template title - `subject` (string, required) — Email subject with \$\{\{token}} placeholders ## Examples **Response** ```json { "data": { "frequently_used": [ { "send_count": 14, "email_template": { "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "body": "

Hi ${{candidate.firstName}}, let us schedule your interview.

", "type": "CUSTOM", "title": "Technical interview invite", "subject": "Next steps for ${{appliedJobTitle}}" } } ], "stage_suggestions": { "items": [ { "send_count": 14, "email_template": { "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "body": "

Hi ${{candidate.firstName}}, let us schedule your interview.

", "type": "CUSTOM", "title": "Technical interview invite", "subject": "Next steps for ${{appliedJobTitle}}" } } ], "stage_name": "Technical Interview" } } } ``` **SDK Code** ```python import requests url = "https://api.letsdeel.com/rest/ats/email-template-suggestions" querystring = {"application_id":"f47ac10b-58cc-4372-a567-0e02b2c3d479","interview_plan_stage_id":"f47ac10b-58cc-4372-a567-0e02b2c3d479"} headers = { "X-Beta": "true", "Authorization": "Bearer " } response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript const url = 'https://api.letsdeel.com/rest/ats/email-template-suggestions?application_id=f47ac10b-58cc-4372-a567-0e02b2c3d479&interview_plan_stage_id=f47ac10b-58cc-4372-a567-0e02b2c3d479'; const options = {method: 'GET', headers: {'X-Beta': 'true', 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/email-template-suggestions?application_id=f47ac10b-58cc-4372-a567-0e02b2c3d479&interview_plan_stage_id=f47ac10b-58cc-4372-a567-0e02b2c3d479" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("X-Beta", "true") 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/email-template-suggestions?application_id=f47ac10b-58cc-4372-a567-0e02b2c3d479&interview_plan_stage_id=f47ac10b-58cc-4372-a567-0e02b2c3d479") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["X-Beta"] = 'true' 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/email-template-suggestions?application_id=f47ac10b-58cc-4372-a567-0e02b2c3d479&interview_plan_stage_id=f47ac10b-58cc-4372-a567-0e02b2c3d479") .header("X-Beta", "true") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api.letsdeel.com/rest/ats/email-template-suggestions?application_id=f47ac10b-58cc-4372-a567-0e02b2c3d479&interview_plan_stage_id=f47ac10b-58cc-4372-a567-0e02b2c3d479', [ 'headers' => [ 'Authorization' => 'Bearer ', 'X-Beta' => 'true', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.letsdeel.com/rest/ats/email-template-suggestions?application_id=f47ac10b-58cc-4372-a567-0e02b2c3d479&interview_plan_stage_id=f47ac10b-58cc-4372-a567-0e02b2c3d479"); var request = new RestRequest(Method.GET); request.AddHeader("X-Beta", "true"); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "X-Beta": "true", "Authorization": "Bearer " ] let request = NSMutableURLRequest(url: NSURL(string: "https://api.letsdeel.com/rest/ats/email-template-suggestions?application_id=f47ac10b-58cc-4372-a567-0e02b2c3d479&interview_plan_stage_id=f47ac10b-58cc-4372-a567-0e02b2c3d479")! 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() ```