> ## 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.

# List mailing visual design assets

> Returns built-in fonts/templates/texts/shapes/frames, or matching stock images plus up to 20 newest organization image uploads. q filters names for non-images, stock names/tags and upload file/name for images. Generated mailing artifacts are excluded from uploads. remote_search_enabled is true, but this handler uses the built-in stock catalog and organization uploads without a third-party search request. Requires permission: one of mailings_manage.



## OpenAPI

````yaml get /admin/mailing_design_assets/{assetType}
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_design_assets/{assetType}:
    get:
      tags:
        - Communications
      summary: List mailing visual design assets
      description: >-
        Returns built-in fonts/templates/texts/shapes/frames, or matching stock
        images plus up to 20 newest organization image uploads. q filters names
        for non-images, stock names/tags and upload file/name for images.
        Generated mailing artifacts are excluded from uploads.
        remote_search_enabled is true, but this handler uses the built-in stock
        catalog and organization uploads without a third-party search request.
        Requires permission: one of mailings_manage.
      operationId: communicationsMailingDesignAssetIndex
      parameters:
        - name: assetType
          in: path
          description: Visual designer asset category.
          required: true
          schema:
            type: string
            enum:
              - fonts
              - templates
              - texts
              - images
              - shapes
              - frames
          example: images
        - name: q
          in: query
          description: Optional asset search text.
          required: false
          schema:
            type: string
          example: education
      responses:
        '200':
          description: Operation result.
          content:
            application/json:
              schema:
                properties:
                  data:
                    properties:
                      asset_type:
                        type: string
                        enum:
                          - fonts
                          - templates
                          - texts
                          - images
                          - shapes
                          - frames
                        example: images
                      client_id:
                        type: integer
                        example: 42
                      remote_search_enabled:
                        type: boolean
                        enum:
                          - true
                        example: true
                      items:
                        type: array
                        items:
                          $ref: >-
                            #/components/schemas/CommunicationsMailingDesignAsset
                    type: object
                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 asset type is unsupported.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    CommunicationsMailingDesignAsset:
      description: >-
        Asset-specific projection. Fonts use family; text uses text;
        shapes/frames use type; templates use page_preset/scene. Images include
        source/URLs/renderability, with upload fields only for organization
        files.
      properties:
        id:
          type: string
          example: stock-community-visit
        name:
          type: string
          example: Community visit
        family:
          type: string
          example: Arial, sans-serif
        text:
          type: string
          example: Dear [donor_name],
        type:
          type: string
          example: rectangle
        page_preset:
          type: string
          example: us_letter_portrait
        scene:
          $ref: '#/components/schemas/CommunicationsMailingVisualScene'
        source:
          type: string
          enum:
            - public_stock
            - hys_workspace_file
          example: public_stock
        source_label:
          type: string
          example: Public stock
        renderable:
          type: boolean
          example: true
        url:
          type: string
          format: uri
          example: https://example.org/community.jpg
        thumbnail_url:
          type: string
          format: uri
          example: https://example.org/community-thumb.jpg
        tags:
          type: array
          items:
            type: string
            example: community
        upload_id:
          type: integer
          example: 42
        file_name:
          type: string
          example: Example
          nullable: true
        permissions:
          type: string
          example: Example
          nullable: true
        created_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
      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
    CommunicationsMailingVisualScene:
      properties:
        version:
          description: Mailing visual designer asset and built-in scene projections.
          type: integer
          example: 1
        page:
          properties:
            preset:
              type: string
              example: us_letter_portrait
            widthPx:
              type: integer
              example: 816
            heightPx:
              type: integer
              example: 1056
            backgroundColor:
              type: string
              example: '#ffffff'
          type: object
        elements:
          type: array
          items:
            description: >-
              Built-in visual-template element; text and shape fields depend on
              its type.
            properties:
              id:
                type: string
                example: heading
              type:
                type: string
                enum:
                  - text
                  - shape
                example: text
              x:
                type: number
                example: 36
              'y':
                type: number
                example: 36
              width:
                type: number
                example: 36
              height:
                type: number
                example: 36
              fontSize:
                type: number
                example: 36
              borderRadius:
                type: number
                example: 36
              borderWidth:
                type: number
                example: 36
              zIndex:
                type: number
                example: 36
              text:
                type: string
                example: Example
                nullable: false
              fontWeight:
                type: string
                example: Example
                nullable: false
              color:
                type: string
                example: Example
                nullable: false
              textAlign:
                type: string
                example: Example
                nullable: false
              fill:
                type: string
                example: Example
                nullable: false
              borderColor:
                type: string
                example: Example
                nullable: false
            type: object
      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.