> ## 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 legacy system automations

> Returns configured email/SMS system automations, delivery health and the programs affected by shared sources. Returns 404 when the workspace system-automation bridge is disabled. Read access requires journeys_view, journeys_manage or beta_features; records remain organization scoped.



## OpenAPI

````yaml get /admin/journeys/system-automations
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/journeys/system-automations:
    get:
      tags:
        - Journeys
      summary: List legacy system automations
      description: >-
        Returns configured email/SMS system automations, delivery health and the
        programs affected by shared sources. Returns 404 when the workspace
        system-automation bridge is disabled. Read access requires
        journeys_view, journeys_manage or beta_features; records remain
        organization scoped.
      operationId: JourneyController_systemAutomations
      responses:
        '200':
          description: List legacy system automations completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JourneyApiSystemAutomations'
        '401':
          description: Authentication is required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Insufficient permission or feature access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: System-automation bridge is unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    JourneyApiSystemAutomations:
      properties:
        data:
          type: array
          items:
            properties:
              id:
                description: Scope/trigger identifier.
                type: string
                example: program:42:new_donor
              trigger:
                description: Legacy automation trigger.
                type: string
                example: new_donor
              title:
                description: Automation title.
                type: string
                example: New donor
              plain_english_trigger:
                description: Readable trigger.
                type: string
                example: New donor
              audience:
                description: Automation audience.
                type: string
                example: Donors
              scope_type:
                description: Scope kind.
                type: string
                enum:
                  - program
                  - client_default
                example: program
              scope_id:
                description: Program ID or client-default identifier such as email-12.
                oneOf:
                  - type: integer
                  - type: string
              scope_name:
                description: Scope name.
                type: string
                example: Child Sponsorship
              program_id:
                description: Record ID in the authenticated organization.
                type: integer
                example: 42
                nullable: true
              program_label:
                description: Program or client-default label.
                type: string
                example: Child Sponsorship
              emailset_id:
                description: Record ID in the authenticated organization.
                type: integer
                example: 42
                nullable: true
              smsset_id:
                description: Record ID in the authenticated organization.
                type: integer
                example: 42
                nullable: true
              channels:
                type: array
                items:
                  properties:
                    channel:
                      description: Channel.
                      type: string
                      enum:
                        - email
                        - sms
                      example: email
                    available:
                      description: Channel availability.
                      type: boolean
                      example: false
                    configured:
                      description: Source template exists.
                      type: boolean
                      example: false
                    enabled:
                      description: Source template enabled.
                      type: boolean
                      example: false
                    set_id:
                      description: Template-set ID.
                      type: integer
                      example: 42
                    set_name:
                      description: Template-set name.
                      type: string
                      example: Example
                      nullable: true
                    template_id:
                      description: Source template ID.
                      type: integer
                      example: 42
                      nullable: true
                    template_label:
                      description: Source template label.
                      type: string
                      example: Welcome
                    supports_variants:
                      description: Whether variants are supported.
                      type: boolean
                      example: false
                    last_activity_at:
                      description: Latest activity.
                      type: string
                      format: date-time
                      example: '2026-10-20T12:00:00Z'
                      nullable: true
                    last_status:
                      description: Latest status.
                      type: string
                      example: Example
                      nullable: true
                    recent_count:
                      description: Recent deliveries.
                      type: integer
                      example: 42
                  type: object
              channel_mode:
                description: Available channels.
                type: string
                enum:
                  - email
                  - sms
                  - both
                example: email
              configuration_status:
                description: Content setup status.
                type: string
                enum:
                  - needs_setup
                  - configured
                  - disabled
                example: needs_setup
              delivery_health:
                description: Delivery status or configuration fallback.
                type: string
                example: recent_activity
              recent_activity_at:
                description: Most recent activity.
                type: string
                format: date-time
                example: '2026-10-20T12:00:00Z'
                nullable: true
              recent_activity_channel:
                description: Most recent channel.
                type: string
                example: Example
                nullable: true
              recent_activity_status:
                description: Most recent status.
                type: string
                example: Example
                nullable: true
              impacted_programs:
                type: array
                items:
                  properties:
                    id:
                      description: Record ID in the authenticated organization.
                      type: integer
                      example: 42
                    name:
                      description: Program name.
                      type: string
                      example: Child Sponsorship
                  type: object
              blast_radius:
                description: Impacted program count.
                type: integer
                example: 42
              is_client_default:
                description: Whether scope is client-default.
                type: boolean
                example: false
              can_convert:
                description: Whether source content is configured.
                type: boolean
                example: false
            type: object
        meta:
          properties:
            total:
              description: Number of automations.
              type: integer
              example: 42
          type: object
      type: object
    ErrorResponse:
      title: ErrorResponse
      description: >-
        Generic error envelope used by most controllers. Most error responses
        pair a human-readable `message` with `status: error`. Some endpoints
        additionally include `errors` (validator errors), `error` (legacy
        single-error string), `code`, or domain-specific context fields.
      required:
        - message
      properties:
        message:
          description: Human-readable error message.
          type: string
          example: Something went wrong. Please try again.
        status:
          description: >-
            Always the literal string `error` for failures. Some endpoints omit
            this field.
          type: string
          example: error
        error:
          description: Legacy single error code/string used by older endpoints.
          type: string
          example: invalid_request
          nullable: true
        code:
          description: >-
            Optional application-level error code (not all endpoints populate
            this).
          type: string
          example: DONOR_NOT_FOUND
          nullable: true
      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
  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.