> 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 email drafts to a candidate as they would be sent

GET https://api.letsdeel.com/rest/ats/candidates/{candidate_id}/email-drafts

Previews the email drafts the authenticated user wrote to a candidate, rendered exactly as sending them would produce. Read it before sending a draft, so the user confirms the final content and recipients.

 **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-30.

Reference: https://docs.deel.wtf/api/reference/endpoints/ats/list-candidate-email-draft-previews-v-2026-10-30

## 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

### Path parameters

- `candidate_id` (string, required) — ID of the candidate the drafts are addressed to

### Query parameters

- `application_id` (string, optional) — Only drafts about this application of the candidate. Required unless the caller is an ATS admin, since access to emails is granted per job.

### Headers

- `X-Beta` (enum, required, default: true) — Opts in to the beta version of this endpoint. Must be `true`.
  - Allowed values: `true`

## Response

### 200

The caller's email drafts to the candidate

- `data` (list of AtsCandidatesCandidateIdEmailDraftsGetResponsesContentApplicationJsonSchemaDataItems, required) — The caller's own drafts to the candidate, most recently changed first, rendered as they would be sent
- `has_more` (boolean, required) — Whether the caller has more drafts to the candidate than the page holds
- `next_cursor` (string, required, nullable) — Always null: the most recently changed drafts are returned in a single page.
- `total_count` (integer, required) — Number of the caller's drafts to the candidate

## Errors

### 400 Bad Request Error

Operation failed.

- `errors` (list of AtsCandidatesCandidateIdEmailDraftsGetResponsesContentApplicationJsonSchemaErrorsItems, 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 AtsCandidatesCandidateIdEmailDraftsGetResponsesContentApplicationJsonSchemaErrorsItems, required) — List of error objects

### 404 Not Found Error

Not found, or not visible to the authenticated user. The two cases are indistinguishable.

- `errors` (list of AtsCandidatesCandidateIdEmailDraftsGetResponsesContentApplicationJsonSchemaErrorsItems, required) — List of error objects

### 500 Internal Server Error

Operation failed.

- `errors` (list of AtsCandidatesCandidateIdEmailDraftsGetResponsesContentApplicationJsonSchemaErrorsItems, required) — List of error objects

## Types

### AtsCandidatesCandidateIdEmailDraftsGetResponsesContentApplicationJsonSchemaDataItems

- `cc` (list of string, required) — CC recipients, resolved to addresses
- `id` (string, required) — The unique identifier of the email draft
- `to` (list of string, required) — Primary recipients, with dynamic recipients such as the candidate resolved to addresses
- `bcc` (list of string, required) — BCC recipients, resolved to addresses
- `body` (string, required) — The rich text HTML body with its placeholders filled in
- `from` (string, required) — The sender the email goes out as: the author's connected mailbox when they have one, otherwise the organization's sender
- `subject` (string, required) — The subject with its placeholders filled in
- `updated_at` (string, required) — The timestamp when the draft was last changed
- `attachments` (list of AtsCandidatesCandidateIdEmailDraftsGetResponsesContentApplicationJsonSchemaDataItemsAttachmentsItems, required) — Files attached to the draft
- `application_id` (string, required, nullable) — The application the draft is about, or null for a draft about the candidate only
- `unresolved_placeholders` (list of string, required) — Placeholders left unfilled in the subject or body. The draft cannot be sent while any remain.

### AtsCandidatesCandidateIdEmailDraftsGetResponsesContentApplicationJsonSchemaErrorsItems

- `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

### AtsCandidatesCandidateIdEmailDraftsGetResponsesContentApplicationJsonSchemaDataItemsAttachmentsItems

- `id` (string, required) — The unique identifier of the attachment
- `file_name` (string, required) — The name of the attached file

## Examples

**Response**

```json
{
  "data": [
    {
      "cc": [
        "ada.lovelace@example.com"
      ],
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "to": [
        "ada.lovelace@example.com"
      ],
      "bcc": [
        "ada.lovelace@example.com"
      ],
      "body": "<p>Hi Ada, thanks for your time today.</p>",
      "from": "Grace Hopper <grace.hopper@acme.com>",
      "subject": "Next steps for the Data Engineer role",
      "updated_at": "2026-10-23T10:30:00.000Z",
      "attachments": [
        {
          "id": "c2d3e4f5-a6b7-8901-bcde-f12345678901",
          "file_name": "interview-guide.pdf"
        }
      ],
      "application_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "unresolved_placeholders": [
        "${{interview.bookingLink}}"
      ]
    }
  ],
  "has_more": false,
  "next_cursor": "string",
  "total_count": 1
}
```

**SDK Code**

```python
import requests

url = "https://api.letsdeel.com/rest/ats/candidates/faac641e-a484-4875-aed5-bfcb0a0691a0/email-drafts"

querystring = {"application_id":"f47ac10b-58cc-4372-a567-0e02b2c3d479"}

headers = {
    "X-Beta": "true",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.letsdeel.com/rest/ats/candidates/faac641e-a484-4875-aed5-bfcb0a0691a0/email-drafts?application_id=f47ac10b-58cc-4372-a567-0e02b2c3d479';
const options = {method: 'GET', headers: {'X-Beta': 'true', Authorization: 'Bearer <token>'}};

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/candidates/faac641e-a484-4875-aed5-bfcb0a0691a0/email-drafts?application_id=f47ac10b-58cc-4372-a567-0e02b2c3d479"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Beta", "true")
	req.Header.Add("Authorization", "Bearer <token>")

	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/candidates/faac641e-a484-4875-aed5-bfcb0a0691a0/email-drafts?application_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 <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.letsdeel.com/rest/ats/candidates/faac641e-a484-4875-aed5-bfcb0a0691a0/email-drafts?application_id=f47ac10b-58cc-4372-a567-0e02b2c3d479")
  .header("X-Beta", "true")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.letsdeel.com/rest/ats/candidates/faac641e-a484-4875-aed5-bfcb0a0691a0/email-drafts?application_id=f47ac10b-58cc-4372-a567-0e02b2c3d479', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'X-Beta' => 'true',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.letsdeel.com/rest/ats/candidates/faac641e-a484-4875-aed5-bfcb0a0691a0/email-drafts?application_id=f47ac10b-58cc-4372-a567-0e02b2c3d479");
var request = new RestRequest(Method.GET);
request.AddHeader("X-Beta", "true");
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "X-Beta": "true",
  "Authorization": "Bearer <token>"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.letsdeel.com/rest/ats/candidates/faac641e-a484-4875-aed5-bfcb0a0691a0/email-drafts?application_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()
```