List drafts
curl --request GET \
--url https://{dsn}/api/v1/{account_id}/drafts \
--header 'X-API-KEY: <api-key>'import requests
url = "https://{dsn}/api/v1/{account_id}/drafts"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://{dsn}/api/v1/{account_id}/drafts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{dsn}/api/v1/{account_id}/drafts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{dsn}/api/v1/{account_id}/drafts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{dsn}/api/v1/{account_id}/drafts")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{dsn}/api/v1/{account_id}/drafts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"object": "Drafts",
"data": [
{
"object": "Email",
"id": "<string>",
"account_id": "<string>",
"thread_id": "<string>",
"date": "2023-11-07T05:31:56Z",
"subject": "<string>",
"from_attendee": {
"identifier": "jsmith@example.com",
"display_name": "<string>",
"identifier_type": "EMAIL_ADDRESS"
},
"to_attendees": [
{
"identifier": "jsmith@example.com",
"display_name": "<string>",
"identifier_type": "EMAIL_ADDRESS"
}
],
"cc_attendees": [
{
"identifier": "jsmith@example.com",
"display_name": "<string>",
"identifier_type": "EMAIL_ADDRESS"
}
],
"bcc_attendees": [
{
"identifier": "jsmith@example.com",
"display_name": "<string>",
"identifier_type": "EMAIL_ADDRESS"
}
],
"reply_to_attendees": [
{
"identifier": "jsmith@example.com",
"display_name": "<string>",
"identifier_type": "EMAIL_ADDRESS"
}
],
"body": "<string>",
"body_plain": "<string>",
"has_attachments": true,
"attachments": [
{
"id": "<string>",
"name": "<string>",
"extension": "<string>",
"size": 123,
"mime": "<string>",
"cid": "<string>",
"inline": true
}
],
"folders": [
"<string>"
],
"is_unread": true,
"is_complete": true,
"headers": [
{
"name": "<string>",
"value": "<string>"
}
],
"origin": "api",
"is_echo": true,
"sent_by": {
"api_key_id": "<string>",
"api_key_name": "<string>",
"metadata": "<string>"
},
"tracking_id": "<string>",
"draft_id": "<string>"
}
],
"has_more": true,
"cursor": "<string>"
}{
"status": 401,
"type": "errors/unauthorized",
"title": "Unauthorized",
"detail": "missing or invalid API key"
}{
"status": 404,
"type": "errors/not_found",
"title": "Not found",
"detail": "email email_94a0d77db739407e932c3b97fef44aac not found"
}Drafts
List drafts
The account’s drafts that have synced, newest first, with cursor paging.
GET
/
{account_id}
/
drafts
List drafts
curl --request GET \
--url https://{dsn}/api/v1/{account_id}/drafts \
--header 'X-API-KEY: <api-key>'import requests
url = "https://{dsn}/api/v1/{account_id}/drafts"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://{dsn}/api/v1/{account_id}/drafts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{dsn}/api/v1/{account_id}/drafts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{dsn}/api/v1/{account_id}/drafts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{dsn}/api/v1/{account_id}/drafts")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{dsn}/api/v1/{account_id}/drafts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"object": "Drafts",
"data": [
{
"object": "Email",
"id": "<string>",
"account_id": "<string>",
"thread_id": "<string>",
"date": "2023-11-07T05:31:56Z",
"subject": "<string>",
"from_attendee": {
"identifier": "jsmith@example.com",
"display_name": "<string>",
"identifier_type": "EMAIL_ADDRESS"
},
"to_attendees": [
{
"identifier": "jsmith@example.com",
"display_name": "<string>",
"identifier_type": "EMAIL_ADDRESS"
}
],
"cc_attendees": [
{
"identifier": "jsmith@example.com",
"display_name": "<string>",
"identifier_type": "EMAIL_ADDRESS"
}
],
"bcc_attendees": [
{
"identifier": "jsmith@example.com",
"display_name": "<string>",
"identifier_type": "EMAIL_ADDRESS"
}
],
"reply_to_attendees": [
{
"identifier": "jsmith@example.com",
"display_name": "<string>",
"identifier_type": "EMAIL_ADDRESS"
}
],
"body": "<string>",
"body_plain": "<string>",
"has_attachments": true,
"attachments": [
{
"id": "<string>",
"name": "<string>",
"extension": "<string>",
"size": 123,
"mime": "<string>",
"cid": "<string>",
"inline": true
}
],
"folders": [
"<string>"
],
"is_unread": true,
"is_complete": true,
"headers": [
{
"name": "<string>",
"value": "<string>"
}
],
"origin": "api",
"is_echo": true,
"sent_by": {
"api_key_id": "<string>",
"api_key_name": "<string>",
"metadata": "<string>"
},
"tracking_id": "<string>",
"draft_id": "<string>"
}
],
"has_more": true,
"cursor": "<string>"
}{
"status": 401,
"type": "errors/unauthorized",
"title": "Unauthorized",
"detail": "missing or invalid API key"
}{
"status": 404,
"type": "errors/not_found",
"title": "Not found",
"detail": "email email_94a0d77db739407e932c3b97fef44aac not found"
}Authorizations
Your access token, from your dashboard under API keys.
Path Parameters
The account's acc_… id.
Query Parameters
How many items per page, 1 to 250.
Required range:
1 <= x <= 250The cursor from the previous page. Leave it out for the first page.