> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shoply.gg/llms.txt
> Use this file to discover all available pages before exploring further.

# Get an email template

> One email: what it is, its `variables` and `parts` (each a `name` and what it is), the marks it must hold (`required`), its `original` HTML, what the store has saved, `shared` (the CSS every email gets) and `baseCss`, Shoply's look for the classes the originals are written with. Each of `html`, `css` and `subject` is the store's own, or null where it is Shoply's original. The HTML is the email's card and the lines under it, with Liquid's marks for what changes from one buyer to the next: `{{ order.id }}` prints a value, escaped, and `{{ parts.delivery }}` a part only Shoply writes. `variables` and `parts` say which an email has. Shoply writes the page round it, its dark look, and a last line under it, "Sent with Shoply", which no template changes. `originalSubject` is the original subject as a sample buyer would get it, and `originalSubjectSource` the same written with its variables.

Needs the `emails.read` permission (Read Email Templates).



## OpenAPI

````yaml /api-reference/openapi.json get /stores/{storeId}/email-templates/{kind}
openapi: 3.1.0
info:
  title: Shoply API
  version: '1'
  description: >-
    Everything a store's own server can do with a secret API key: its catalogue,
    orders, customers, marketing, finance and the rest of what the dashboard
    does. And the Customer API, which a buyer's own device asks with a token of
    theirs.
servers:
  - url: https://api.shoply.gg/v1
security:
  - apiKey: []
tags:
  - name: API key
  - name: Store
  - name: Domain
  - name: Payment methods
  - name: Analytics
  - name: Storefronts
  - name: Storefront code
  - name: Payment Routing
  - name: Custom payment methods
  - name: Products
  - name: Product pictures
  - name: Stock
  - name: Categories
  - name: Upsells
  - name: Subscriptions
  - name: Orders
  - name: Invoices
  - name: Reviews
  - name: Coupons
  - name: Coupon categories
  - name: Coupon pop-up
  - name: Sales
  - name: Blog
  - name: Search settings
  - name: Redirects
  - name: Sitemap
  - name: Cart Recovery
  - name: Email Marketing
  - name: Email Templates
  - name: Customers
  - name: Affiliates
  - name: Support Tickets
  - name: Blacklist
  - name: Fraud protection
  - name: Disputes
  - name: Finance
  - name: Tax
  - name: Expenses
  - name: Expense setup
  - name: API requests
  - name: Webhook endpoints
  - name: Webhook deliveries
  - name: Customer API
paths:
  /stores/{storeId}/email-templates/{kind}:
    get:
      tags:
        - Email Templates
      summary: Get an email template
      description: >-
        One email: what it is, its `variables` and `parts` (each a `name` and
        what it is), the marks it must hold (`required`), its `original` HTML,
        what the store has saved, `shared` (the CSS every email gets) and
        `baseCss`, Shoply's look for the classes the originals are written with.
        Each of `html`, `css` and `subject` is the store's own, or null where it
        is Shoply's original. The HTML is the email's card and the lines under
        it, with Liquid's marks for what changes from one buyer to the next: `{{
        order.id }}` prints a value, escaped, and `{{ parts.delivery }}` a part
        only Shoply writes. `variables` and `parts` say which an email has.
        Shoply writes the page round it, its dark look, and a last line under
        it, "Sent with Shoply", which no template changes. `originalSubject` is
        the original subject as a sample buyer would get it, and
        `originalSubjectSource` the same written with its variables.


        Needs the `emails.read` permission (Read Email Templates).
      operationId: emailTemplates.show
      parameters:
        - name: storeId
          in: path
          required: true
          description: >-
            The store's ID. A key reaches the store it was made in: `GET /key`
            answers which.
          schema:
            type: string
        - name: kind
          in: path
          required: true
          description: >-
            Which email: `receipt`, `invoice`, `reward`, `panel-code`,
            `balance-code`, `site-code`, `ticket-reply`, `sub-renewal`,
            `sub-charged`, `sub-due`, `sub-declined`, `sub-paused`, `sub-ended`,
            `recovery-first`, `recovery-declined`, `recovery-second`,
            `winback-first`, `winback-second`.
          schema:
            type: string
      responses:
        '200':
          description: It worked.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    nullable: true
                  code:
                    nullable: true
                  data:
                    type: object
                    properties:
                      kind:
                        type: string
                      group:
                        type: string
                      name:
                        type: string
                      when:
                        type: string
                      marketing:
                        type: boolean
                      required:
                        type: array
                        items:
                          type: string
                      variables:
                        type: array
                        items:
                          type: object
                          properties:
                            name:
                              type: string
                            about:
                              type: string
                      parts:
                        type: array
                        items:
                          type: object
                          properties:
                            name:
                              type: string
                            about:
                              type: string
                      original:
                        type: string
                      originalSubject:
                        type: string
                      originalSubjectSource:
                        type: string
                      html:
                        nullable: true
                      css:
                        nullable: true
                      subject:
                        nullable: true
                      updatedAt:
                        nullable: true
                      shared:
                        nullable: true
                      baseCss:
                        type: string
              example:
                success: true
                message: null
                code: null
                data:
                  kind: receipt
                  group: Orders
                  name: Order Receipt
                  when: When an order is paid, and when you send it again
                  marketing: false
                  required:
                    - parts.delivery
                    - parts.summary
                  variables:
                    - name: store.name
                      about: Your store's name
                    - name: store.url
                      about: Your store's address
                  parts:
                    - name: parts.delivery
                      about: 'What was bought: keys, downloads and instructions'
                    - name: parts.getting_started
                      about: Your instructions for every order, from Settings
                  original: >-
                    <table class="card" role="presentation" width="100%"
                    cellpadding="0" cellspacing="0" border="0">
                      <tr>
                        <td class="card-body" bgcolor="#ffffff">
                          <div class="logo">{{ parts.logo }}</div>
                          <div class="title">Your order is delivered</div>
                          <div class="lead muted">{{ order.paid_at }}</div>
                          {{ parts.delivery }}
                          {{ parts.getting_started }}
                          {{ parts.buttons }}
                          …
                  originalSubject: >-
                    Your Northwind Keys order is delivered
                    (a2855h0p1y4-71329ed4d95-1000427)
                  originalSubjectSource: Your {{ store.name }} order is delivered ({{ order.id }})
                  html: null
                  css: null
                  subject: null
                  updatedAt: null
                  shared: null
                  baseCss: |-
                    /*
                     * Shoply's look for the parts of an email a template is made of: what each original's
                     * classes mean. Under the store's shared CSS and each email's own, which change any of it.
                     * EmailTemplates::baseCss() puts the shop's link colour where #6a3ce2 is. The values are
                     * EmailLayout's, so that an original looks as its builder's message does.
                     */
                    .card-body { background-color: #ffffff; border: 1…
        '401':
          $ref: '#/components/responses/NoKey'
        '403':
          $ref: '#/components/responses/NotAllowed'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooMany'
      x-codeSamples:
        - lang: javascript
          label: Node.js
          source: |
            import Shoply from "@shoplygg/node";

            const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });

            const result = await shoply.emailTemplates.show("KIND");
        - lang: php
          label: PHP
          source: |
            <?php

            require 'vendor/autoload.php';

            $shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);

            $result = $shoply->emailTemplates->show('KIND');
        - lang: python
          label: Python
          source: |
            import shoply

            client = shoply.Client()  # reads SHOPLY_API_KEY

            result = client.emailTemplates.show("KIND")
components:
  responses:
    NoKey:
      description: >-
        No API key was sent, or the one sent is not a live key:
        `api_key_required`, `invalid_api_key`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    NotAllowed:
      description: >-
        The key is real and may not do this: `missing_scope` (with
        `requiredScope`), `ip_not_allowed`, `account_unavailable`, or
        `dashboard_only` for something only a person in the dashboard may do.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    NotFound:
      description: >-
        There is no such thing in this store: `not_found`. A store that is not
        the key's own is answered the same way.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    TooMany:
      description: >-
        The key has used up its budget for now: `rate_limited`. `Retry-After`
        says how many seconds to wait.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
  schemas:
    Refusal:
      type: object
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          description: What is wrong, in words for a person.
        code:
          type: string
          description: What is wrong, as a word that does not change.
        data:
          nullable: true
        errors:
          type: object
          description: >-
            For `validation_failed`: what is wrong with each field, by the
            field's name.
          additionalProperties:
            type: string
      required:
        - success
        - message
        - code
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        A secret API key, made under Developers in the dashboard:
        `Authorization: Bearer shoply_sk_...`

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.