Skip to main content
GET
/
api
/
email
/
drafts
List outbound email drafts
curl --request GET \
  --url https://dev.exante.app/api/email/drafts \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "from_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "from_email": "<string>",
      "to": [
        "<string>"
      ],
      "cc": [
        "<string>"
      ],
      "bcc": [
        "<string>"
      ],
      "subject": "<string>",
      "body_text": "<string>",
      "body_html": "<string>",
      "context_type": "<string>",
      "context_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "planned_send_at": "2023-11-07T05:31:56Z",
      "status": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "count": 123
}
Retrieve all email drafts for your organization. Use query parameters to filter drafts by their associated context (e.g., all drafts related to a specific invoice).

​
Query Parameters

ParameterDescription
context_typeFilter by entity type (e.g., "invoice")
context_idFilter by specific entity UUID

​
Example Request

List all drafts for a specific invoice: 
GET /api/email/drafts?context_type=invoice&context_id=a1b2c3d4-...

​
Response

Returns an array of draft records with a count: 
{
  "items": [
    {
      "uid": "draft-uuid-1",
      "from_account_id": "account-uuid",
      "from_email": "sender@mycompany.com",
      "to": ["customer@example.com"],
      "subject": "Payment Reminder",
      "status": "draft",
      "planned_send_at": null,
      "created_at": "2024-03-25T10:30:00Z",
      "updated_at": "2024-03-25T10:30:00Z"
    },
    {
      "uid": "draft-uuid-2",
      "from_account_id": "account-uuid",
      "from_email": "sender@mycompany.com",
      "to": ["customer@example.com"],
      "subject": "Final Notice",
      "status": "draft",
      "planned_send_at": "2024-03-26T09:00:00Z",
      "created_at": "2024-03-25T11:00:00Z",
      "updated_at": "2024-03-25T11:00:00Z"
    }
  ],
  "count": 2
}

​
Use Cases

  • Draft inbox - Show all pending drafts for review
  • Context panel - Display drafts related to the entity a user is viewing
  • Scheduled queue - Filter drafts with planned_send_at to show upcoming sends

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Draft list

​
items
object[]
required
​
count
integer
required