Email Templates Queries

Access email templates for automated communications.

`EmailTemplate` — Returns a single email template based on the `id` provided

query GetEmailTemplate($id: ID) {
  EmailTemplate(id: $id) {
    id
    label
    document_type
    default
    active
    body
    to
    cc
    bcc
    object
    files { id }
    created_at
    updated_at
    deleted_at
  }
}

{
  "id": 100012
}

`EmailTemplates` — Returns a list of email templates with ordering, filters, and search

query EmailTemplates(
  $where: QueryEmailTemplatesWhereWhereConditions,
  $orderBy: [QueryEmailTemplatesOrderByOrderByClause!],
  $search: String
) {
  EmailTemplates(
    where: $where
    orderBy: $orderBy
    search: $search
  ) {
    id
    label
    document_type
    active
    default
    object
    created_at
    updated_at
  }
}

{
  "where": {
    "AND": [
      { "column": "ACTIVE", "operator": "EQ", "value": true }
    ]
  },
  "orderBy": [
    { "column": "LABEL", "order": "ASC" }
  ],
  "search": "template name"
}

Available fields

Field	Type	Description
`id`	Int	Unique identifier of the email template.
`label`	String	Label of the email template.
`document_type`	Type	Type of document (invoice, estimate, order, etc.).
`default`	Boolean	Whether this is the default template for the document type.
`active`	Boolean	Whether the email template is active.
`body`	String	Email body content.
`to`	[String]	Default TO recipients.
`cc`	[String]	Default CC recipients.
`bcc`	[String]	Default BCC recipients.
`object`	String	Email subject line.
`files`	[File]	Attached files.
`created_at`	DateTime	Creation date.
`updated_at`	DateTime	Last update date.
`deleted_at`	DateTime	Deletion date (soft delete).

Filters

You can create filters based on following fields

id - Int
Example: `{ "column": "ID", "operator": "EQ", "value": 100012 }`

label - String
Example: `{ "column": "LABEL", "operator": "LIKE", "value": "%invoice%" }`

document_type - Type
Example: `{ "column": "DOCUMENT_TYPE", "operator": "EQ", "value": "invoice" }`

active - Boolean
Example: `{ "column": "ACTIVE", "operator": "EQ", "value": true }`

default - Boolean
Example: `{ "column": "DEFAULT", "operator": "EQ", "value": true }`

Sorting

You can sort data based on following fields: label, active, default, document_type

query SortEmailTemplates(
  $where: QueryEmailTemplatesWhereWhereConditions
) {
  EmailTemplates(
    where: $where
    orderBy: [{ column: LABEL, order: ASC }]
  ) {
    id
    label
    document_type
    active
    default
    object
  }
}

Example of data returned

{
  "data": {
    "EmailTemplates": [
      {
        "id": 100001,
        "label": "Invoice Reminder",
        "document_type": "invoice",
        "active": true,
        "default": true,
        "object": "Payment Reminder - Invoice {{invoice_number}}",
        "created_at": "2025-01-01T09:00:00Z",
        "updated_at": "2025-01-15T10:30:00Z"
      },
      {
        "id": 100002,
        "label": "Order Confirmation",
        "document_type": "order",
        "active": true,
        "default": false,
        "object": "Order Confirmation - {{order_number}}",
        "created_at": "2025-01-01T09:00:00Z",
        "updated_at": "2025-01-01T09:00:00Z"
      }
    ]
  }
}

Enums

`Type` (EmailTemplate)

Value	Description
`invoice`	Invoice document.
`estimate`	Estimate/quote document.
`order`	Sales order document.
`shipping_order`	Shipping order document.
`credit_note`	Credit note document.
`purchase`	Purchase order document.
`purchase_receipt`	Purchase receipt document.
`product_return`	Product return document.
`delivery`	Delivery document.
`refund`	Refund document.
`stock_adjustment`	Stock adjustment document.
`stock_entry`	Stock entry document.
`stock_removal`	Stock removal document.
`stock_transfer`	Stock transfer document.
`subscription`	Subscription document.
`b2b_store`	B2B store document.

`EmailTemplateFileType`

Value	Description
`emailTemplateFiles`	Files attached to the email template.