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

# Read a mailing template editor

> Returns the tenant-owned template with full HTML/serialized design/settings, bindings, form-aware merge groups and latest-record preview context. System templates can be read but cannot be edited, archived or duplicated. Requires permission: one of mailings_view, mailings_generate, mailings_manage, manage_email, reports_view, reports_manage.



## OpenAPI

````yaml get /admin/mailing_templates/{id}
openapi: 3.0.0
info:
  title: Gratona API
  description: >-
    REST API for the Gratona fundraising platform, including donor, donation,
    sponsorship, program, event, and integration workflows. Endpoints are
    organized by tag. Most endpoints require either a Passport bearer token or
    an issued API key — see the Security Schemes section.
  contact:
    name: Gratona Engineering
    url: https://gratona.com
    email: devs@gratona.com
  version: 1.0.0
servers:
  - url: https://api.gratona.com/v1
    description: Server Version 1.0.0
security: []
tags:
  - name: Auth
    description: >-
      Login, signup, logout, password reset, and email verification for admin
      users and donors.
  - name: Donors
    description: >-
      Donor records: CRUD, profile fields, household linkage, search, filters,
      merge, and duplicate detection.
  - name: Donations
    description: >-
      Individual donation records, recurring commitments, soft credits, refunds,
      designations, and exports.
  - name: Sponsorships
    description: >-
      Donor-to-entity commitment relationships, lifecycle transitions, and
      commitment-specific filters.
  - name: Entities
    description: >-
      Recipient records (children, families, projects, animals, etc.), their
      status, and entity-level fields.
  - name: Programs
    description: >-
      Program / campaign configuration: hierarchy, settings, and program-level
      metadata.
  - name: Forms
    description: >-
      Custom form builder (HysForm), form fields, standardized donor fields, and
      field migrations.
  - name: Trips
    description: >-
      Mission-trip management: trips, participants, budgets, tasks,
      e-signatures, fundraising milestones, and background checks.
  - name: Communications
    description: >-
      Email templates, SMS, newsletters, donor email manager, and per-donor
      notes.
  - name: Payments
    description: >-
      Payment-gateway management (Stripe, PayPal, Flutterwave, QuickBooks).
      Excludes inbound webhooks — see the Webhooks tag.
  - name: Reports
    description: Dashboards, analytics, scheduled reports, and exports.
  - name: Admin
    description: >-
      Client-account administration: users, groups/permissions, settings,
      integrations, and account lifecycle.
  - name: Donor Portal
    description: >-
      Endpoints consumed by the donor-facing portal (donor login, dashboard,
      donation history, messages).
  - name: Recipient Portal
    description: Endpoints consumed by the recipient-facing portal.
  - name: Public
    description: >-
      Unauthenticated public endpoints: donor signup, public trip pages,
      peer-to-peer campaigns, public checkout.
  - name: Webhooks
    description: >-
      Inbound webhooks from third parties (Stripe, PayPal, Flutterwave, Checkr,
      DropboxSign). Annotated minimally for reference; payload shapes are owned
      by the upstream provider.
  - name: Events
    description: >-
      Event setup, invitations, registration, ticketing, attendance and event
      reporting.
  - name: Journeys
    description: >-
      Journey graphs, activation, enrollment, message templates and event
      follow-up automations.
  - name: Tasks
    description: Workspace tasks, assignments, saved task views and record collaboration.
  - name: Fundraising
    description: >-
      Fundraising portfolios, stewardship plans, giving anniversaries and
      personal donor follow-up.
  - name: Impact Stories
    description: Story intake, review, assets, consent and publication workflows.
  - name: Integrations
    description: Workspace integration connections, mappings, synchronization and recovery.
  - name: Email Calendar
    description: Connected email/calendar accounts and donor interactions.
  - name: Spaces
    description: Workspace Spaces and collaborative Pages.
  - name: Library
    description: Workspace documents, source connections, files and analysis.
  - name: Intelligence
    description: Donor intelligence and Tali workspace workflows.
  - name: Automation
    description: >-
      V3 automation primitive discovery, input validation, invocation and Zapier
      contracts.
  - name: Schema
    description: V3 model, enum, capability and scope discovery.
  - name: Zapier
    description: Zapier automation connections, polling feeds and actions.
  - name: Files
    description: Files
  - name: Client
    description: Client
  - name: Payment Gateways
    description: Payment Gateways
  - name: Email Settings
    description: Email Settings
  - name: Admin Dashboard
    description: Admin Dashboard
  - name: Recipients
    description: Recipients
  - name: Historical Archived Updates
    description: Historical Archived Updates
  - name: Team & access
    description: Team & access
  - name: Settings
    description: Settings
  - name: Notifications
    description: Notifications
  - name: Participation
    description: Participation
  - name: Users
    description: Users
  - name: Wrapped
    description: Wrapped
  - name: Donor SignUp
    description: Donor SignUp
  - name: Frontend
    description: Frontend
  - name: User
    description: User
  - name: Workspace
    description: Workspace
paths:
  /admin/mailing_templates/{id}:
    get:
      tags:
        - Communications
      summary: Read a mailing template editor
      description: >-
        Returns the tenant-owned template with full HTML/serialized
        design/settings, bindings, form-aware merge groups and latest-record
        preview context. System templates can be read but cannot be edited,
        archived or duplicated. Requires permission: one of mailings_view,
        mailings_generate, mailings_manage, manage_email, reports_view,
        reports_manage.
      operationId: communicationsMailingTemplateShow
      parameters:
        - name: id
          in: path
          description: Id in the current organization.
          required: true
          schema:
            type: integer
          example: 42
      responses:
        '200':
          description: Operation result.
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/CommunicationsMailingTemplateDetail'
                type: object
        '401':
          description: Authentication is required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
        '403':
          description: >-
            The authenticated user lacks access to this workflow or its related
            records.
        '404':
          description: The template is unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    CommunicationsMailingTemplateDetail:
      allOf:
        - $ref: '#/components/schemas/CommunicationsMailingTemplate'
        - properties:
            available_programs:
              type: array
              items:
                properties:
                  id:
                    description: Organization-owned record identifier.
                    type: integer
                    example: 42
                    nullable: false
                  name:
                    description: Serialized value.
                    type: string
                    example: Example
                    nullable: false
                type: object
            merge_schema:
              type: array
              items:
                $ref: '#/components/schemas/CommunicationsMailingMergeSchemaGroup'
            merge_tags:
              type: object
              additionalProperties:
                properties:
                  name:
                    description: Serialized value.
                    type: string
                    example: Example
                    nullable: false
                  mergeTags:
                    type: object
                    additionalProperties:
                      properties:
                        name:
                          type: string
                          example: Donor Name
                        value:
                          type: string
                          example: '[donor_name]'
                        sample:
                          type: string
                          example: ''
                      type: object
                type: object
            preview_context:
              $ref: '#/components/schemas/CommunicationsMailingPreviewContext'
          type: object
    UnauthorizedResponse:
      title: UnauthorizedResponse
      description: >-
        Returned with HTTP 401 when the request lacks a valid Passport bearer
        token, a valid `X-HYS-API-Key`, or a valid session. The body is the
        simple `{message, status}` envelope emitted by `AuthenticateApiOrKey`.
      required:
        - message
        - status
      properties:
        message:
          description: >-
            Always the literal string `Unauthorized` from the `auth.api_or_key`
            middleware. Login endpoints return `Invalid Credentials` instead.
          type: string
          example: Unauthorized
        status:
          type: string
          example: error
      type: object
    NotFoundResponse:
      title: NotFoundResponse
      description: >-
        Returned with HTTP 404 when a resource lookup misses (typically because
        the id doesn't exist OR is scoped to a different `client_id`). Note:
        many endpoints intentionally collapse 'not found' and 'forbidden' into a
        single 404 to avoid leaking which records exist in another tenant.
      required:
        - message
      properties:
        message:
          description: >-
            Human-readable message. Often a more specific string like `Donor not
            found` or `Trip not found`.
          type: string
          example: Not Found
        status:
          type: string
          example: error
      type: object
    CommunicationsMailingTemplate:
      properties:
        id:
          description: Organization-owned record identifier.
          type: integer
          example: 42
          nullable: false
        name:
          type: string
          example: Education impact letter
        scope_type:
          type: string
          enum:
            - donor
            - sponsorship
            - household
          example: donor
        template_kind:
          type: string
          enum:
            - custom
            - system
          example: custom
        preset_key:
          description: Serialized value.
          type: string
          example: Example
          nullable: true
        render_strategy:
          type: string
          example: unlayer_pdf
        description:
          description: Serialized value.
          type: string
          example: Example
          nullable: true
        is_active:
          type: boolean
          example: true
        program_ids:
          type: array
          items:
            description: Organization-owned record identifier.
            type: integer
            example: 42
            nullable: false
        program_bindings:
          type: array
          items:
            properties:
              id:
                description: Organization-owned record identifier.
                type: integer
                example: 42
                nullable: false
              program_id:
                description: Organization-owned record identifier.
                type: integer
                example: 42
                nullable: false
              name:
                description: Serialized value.
                type: string
                example: Example
                nullable: true
            type: object
        applicability_label:
          type: string
          example: Client-wide
        documents:
          type: array
          items:
            $ref: '#/components/schemas/CommunicationsMailingDocument'
        has_labels:
          type: boolean
          example: true
        created_at:
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        updated_at:
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
      type: object
    CommunicationsMailingMergeSchemaGroup:
      description: >-
        Form metadata appears only for form-specific groups; other groups
        include key/name/merge_tags.
      properties:
        key:
          type: string
          example: donor
        name:
          type: string
          example: Donor
        merge_tags:
          type: object
          additionalProperties:
            properties:
              name:
                type: string
                example: Donor Name
              value:
                type: string
                example: '[donor_name]'
            type: object
        form_category:
          type: string
          enum:
            - donor
            - recipient
          example: donor
        form_id:
          description: Organization-owned record identifier.
          type: integer
          example: 42
          nullable: false
        form_name:
          description: Serialized value.
          type: string
          example: Example
          nullable: false
        program_ids:
          type: array
          items:
            description: Organization-owned record identifier.
            type: integer
            example: 42
            nullable: false
        program_names:
          type: array
          items:
            description: Serialized value.
            type: string
            example: Example
            nullable: false
        use_standardized_fields:
          type: boolean
          example: true
      type: object
    CommunicationsMailingPreviewContext:
      description: >-
        Latest suitable organization record is selected automatically; missing
        data returns an empty merge_data array and omits record identifiers.
      properties:
        preview_type:
          type: string
          example: donor
        donor_id:
          description: Organization-owned record identifier.
          type: integer
          example: 42
          nullable: false
        donor_entity_id:
          description: Organization-owned record identifier.
          type: integer
          example: 42
          nullable: false
        trip_participant_id:
          description: Organization-owned record identifier.
          type: integer
          example: 42
          nullable: false
        entity_id:
          description: Organization-owned record identifier.
          type: integer
          example: 42
          nullable: false
        donor_hysform_id:
          description: Organization-owned record identifier.
          type: integer
          example: 42
          nullable: true
        entity_hysform_id:
          description: Organization-owned record identifier.
          type: integer
          example: 42
          nullable: true
        merge_data:
          oneOf:
            - description: >-
                Actual organization/donor/recipient preview fields plus dynamic
                form or journey merge values.
              properties:
                organization_name:
                  description: Serialized value.
                  type: string
                  example: Example
                  nullable: false
                organization_email:
                  type: string
                  format: email
                  nullable: true
                organization_website:
                  description: Serialized value.
                  type: string
                  example: Example
                  nullable: true
                organization_phone:
                  description: Serialized value.
                  type: string
                  example: Example
                  nullable: true
                base_currency:
                  description: Serialized value.
                  type: string
                  example: Example
                  nullable: true
                organization_timezone:
                  type: string
                  example: Africa/Kampala
                donor_id:
                  description: Organization-owned record identifier.
                  type: integer
                  example: 42
                  nullable: false
                donor_name:
                  description: Serialized value.
                  type: string
                  example: Example
                  nullable: false
                donor_email:
                  type: string
                  nullable: true
                email:
                  type: string
                  nullable: true
                username:
                  description: Serialized value.
                  type: string
                  example: Example
                  nullable: true
                recipient_name:
                  description: Serialized value.
                  type: string
                  example: Example
                  nullable: false
                household_id:
                  description: Organization-owned record identifier.
                  type: integer
                  example: 42
                  nullable: true
                donor_entity_id:
                  description: Organization-owned record identifier.
                  type: integer
                  example: 42
                  nullable: false
                entity_id:
                  description: Organization-owned record identifier.
                  type: integer
                  example: 42
                  nullable: false
                program_id:
                  description: Organization-owned record identifier.
                  type: integer
                  example: 42
                  nullable: false
                program_name:
                  description: Serialized value.
                  type: string
                  example: Example
                  nullable: true
                commitment_id:
                  description: Organization-owned record identifier.
                  type: integer
                  example: 42
                  nullable: false
                sponsorship_amount:
                  oneOf:
                    - type: number
                    - type: string
                sponsorship_frequency:
                  description: Serialized value.
                  type: string
                  example: Example
                  nullable: false
                sponsorship_start_date:
                  description: Serialized value.
                  type: string
                  example: Example
                  nullable: true
                last_payment_date:
                  description: Serialized value.
                  type: string
                  example: Example
                  nullable: true
                next_payment_date:
                  description: Serialized value.
                  type: string
                  example: Example
                  nullable: true
                generated_date:
                  type: string
                  example: 10/20/2026
                generated_datetime:
                  description: Serialized value.
                  type: string
                  example: Example
                  nullable: false
                year:
                  type: integer
                  example: 2026
              type: object
              additionalProperties: {}
            - type: array
              items: {}
              maxItems: 0
      type: object
    CommunicationsMailingDocument:
      description: >-
        Template document. Compact list responses omit html, design and
        settings_json.
      properties:
        id:
          description: Organization-owned record identifier.
          type: integer
          example: 42
          nullable: false
        document_kind:
          type: string
          enum:
            - letter
            - label
          example: letter
        page_preset:
          type: string
          example: us_letter_portrait
        editor_mode:
          type: string
          enum:
            - unlayer
            - html
            - canvaclone
          example: unlayer
        html:
          type: string
          example: <p>Dear [donor_name], thank you for your support.</p>
          nullable: true
        design:
          description: >-
            Stored serialized editor design; object input is JSON-encoded before
            storage.
          type: string
          example: '{`body`:{}}'
          nullable: true
        settings_json:
          oneOf:
            - type: object
              additionalProperties: {}
            - type: array
              items: {}
            - type: string
              enum:
                - null
              nullable: true
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      description: Passport bearer token authentication for legacy admin sessions.
      scheme: bearer
      bearerFormat: JWT
    apiKeyAuth:
      type: apiKey
      description: Gratona API key sent with the compatibility header X-HYS-API-Key.
      name: X-HYS-API-Key
      in: header

````

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