> ## 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 automated SMS sets

> Returns compact sets/templates, program association, trigger catalog and template validation results. include_template_content optionally includes bodies. Can lazily initialize disabled default SMS templates and hides the Journeys library when configured. The current authenticated sendblue response includes sensitive credential fields. Requires permission: one of manage_sms.



## OpenAPI

````yaml get /admin/auto_sms
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/auto_sms:
    get:
      tags:
        - Communications
      summary: List automated SMS sets
      description: >-
        Returns compact sets/templates, program association, trigger catalog and
        template validation results. include_template_content optionally
        includes bodies. Can lazily initialize disabled default SMS templates
        and hides the Journeys library when configured. The current
        authenticated sendblue response includes sensitive credential fields.
        Requires permission: one of manage_sms.
      operationId: communicationsAutoSmsSmsManage
      parameters:
        - name: include_template_content
          in: query
          description: Include template message bodies in the compact list; defaults false.
          required: false
          schema:
            type: boolean
          example: false
      responses:
        '200':
          description: Operation result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunicationsAutoSmsList'
        '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.
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    CommunicationsAutoSmsList:
      properties:
        smssets:
          type: array
          items:
            properties:
              id:
                description: Organization-owned record identifier.
                type: integer
                example: 42
                nullable: false
              client_id:
                description: Organization-owned record identifier.
                type: integer
                example: 42
                nullable: false
              name:
                type: string
                example: Education SMS templates
              from_number:
                type: string
                example: '+15551234567'
                nullable: true
              sms_line_id:
                description: Organization-owned record identifier.
                type: integer
                example: 42
                nullable: 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
              program_id:
                description: Organization-owned record identifier.
                type: integer
                example: 42
                nullable: true
              program:
                properties:
                  id:
                    description: Organization-owned record identifier.
                    type: integer
                    example: 42
                    nullable: false
                  client_id:
                    description: Organization-owned record identifier.
                    type: integer
                    example: 42
                    nullable: false
                  name:
                    description: Serialized value.
                    type: string
                    example: Example
                    nullable: false
                type: object
                nullable: true
              smstemplates:
                type: array
                items:
                  description: >-
                    Message is omitted unless include_template_content=true;
                    to_numbers is never included in the list projection.
                  properties:
                    id:
                      description: Organization-owned record identifier.
                      type: integer
                      example: 42
                      nullable: false
                    client_id:
                      description: Organization-owned record identifier.
                      type: integer
                      example: 42
                      nullable: false
                    smsset_id:
                      description: Organization-owned record identifier.
                      type: integer
                      example: 42
                      nullable: false
                    trigger:
                      type: string
                      example: pay_receipt
                    message:
                      type: string
                      example: >-
                        Thank you for your [method] gift of [total_amount] to
                        [designations] on [date].
                      nullable: true
                    variant_type:
                      type: string
                      example: default
                    disabled:
                      type: integer
                      enum:
                        - 0
                        - 1
                      example: 1
                  type: object
            type: object
        template_errors:
          $ref: '#/components/schemas/CommunicationsAutoSmsTemplateErrors'
        t_array:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/CommunicationsAutoSmsTriggerDefinition'
        sendblue:
          $ref: '#/components/schemas/CommunicationsSendblueConfiguration'
      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
    CommunicationsAutoSmsTemplateErrors:
      description: >-
        SMS-set-id to trigger validation map; empty state serializes as an
        array.
      oneOf:
        - type: object
          additionalProperties:
            description: Trigger-keyed validation messages.
            oneOf:
              - type: object
                additionalProperties:
                  type: array
                  items:
                    properties:
                      status:
                        type: string
                        enum:
                          - info
                          - danger
                          - warning
                          - success
                        example: warning
                      message:
                        type: string
                        example: No SMS Message Body
                      missing:
                        type: string
                        example: '[amount] shortcode is missing'
                    type: object
              - type: array
                items: {}
                maxItems: 0
        - type: array
          items: {}
          maxItems: 0
    CommunicationsAutoSmsTriggerDefinition:
      description: >-
        Trigger metadata is program-dependent. to=true means the template stores
        explicit administrator recipient numbers; variant fields appear for
        supported receipt triggers.
      properties:
        title:
          type: string
          example: Donor Payment Receipt
        to:
          type: boolean
          example: true
        shortcodes:
          type: array
          items:
            type: string
            example: total_amount
        required:
          type: array
          items:
            type: string
            example: total_amount
        required_shortcodes:
          type: array
          items:
            type: string
        supports_variants:
          type: boolean
          example: true
        variant_shortcodes:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        variant_recommended_shortcodes:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
      type: object
    CommunicationsSendblueConfiguration:
      description: >-
        Authenticated organization Sendblue configuration. The current API
        includes credential values; treat this response as sensitive. Examples
        contain no real credentials.
      properties:
        mode:
          type: string
          enum:
            - disabled
            - client_managed
            - hys_managed
          example: client_managed
        enabled:
          type: boolean
          example: true
        default_sms_line_id:
          description: Organization-owned record identifier.
          type: integer
          example: 42
          nullable: true
        default_from_number:
          type: string
          example: '+15551234567'
        api_key_id:
          description: >-
            Sensitive credential returned by the authenticated configuration
            endpoint. Example is a placeholder.
          type: string
          example: REDACTED
        api_secret_key:
          description: >-
            Sensitive credential returned by the authenticated configuration
            endpoint. Example is a placeholder.
          type: string
          example: REDACTED
        callback_secret:
          description: >-
            Sensitive credential returned by the authenticated configuration
            endpoint. Example is a placeholder.
          type: string
          example: REDACTED
        webhook_secret:
          description: >-
            Sensitive credential returned by the authenticated configuration
            endpoint. Example is a placeholder.
          type: string
          example: REDACTED
        managed_subaccount_id:
          description: Serialized value.
          type: string
          example: Example
          nullable: true
        managed_provisioning_status:
          type: string
          example: inactive
        requested_area_code:
          description: Serialized value.
          type: string
          example: Example
          nullable: true
        assigned_line_id:
          description: Organization-owned record identifier.
          type: integer
          example: 42
          nullable: true
        assigned_number:
          type: string
          example: '+15551234567'
          nullable: true
        line_metadata:
          oneOf:
            - type: object
              additionalProperties: {}
            - type: array
              items: {}
        lines:
          type: array
          items:
            properties:
              phone_number:
                type: string
                example: '+15551234567'
              label:
                description: Serialized value.
                type: string
                example: Example
                nullable: false
              provider_line_id:
                description: Serialized value.
                type: string
                example: Example
                nullable: true
              line_role:
                type: string
                example: general
              assigned_user_id:
                description: Organization-owned record identifier.
                type: integer
                example: 42
                nullable: true
              visibility:
                type: string
                example: shared
              status:
                type: string
                example: active
              metadata:
                type: object
                additionalProperties: {}
            type: object
            additionalProperties: {}
      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.