> ## 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 compatible program setup modules

> Returns current-organization settings, donor/recipient forms and email/SMS sets with compatibility, recommendation and preview details. Blocked settings are omitted. Unsupported/blank type becomes null and receives generic recommendations; it does not return422. Form summaries include standardized donor fields when enabled. Recommended IDs are suggestions and do not attach modules. Requires permission: one of programs_view, manage_programs, program-all.



## OpenAPI

````yaml get /admin/program/setup-options
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/program/setup-options:
    get:
      tags:
        - Programs
      summary: List compatible program setup modules
      description: >-
        Returns current-organization settings, donor/recipient forms and
        email/SMS sets with compatibility, recommendation and preview details.
        Blocked settings are omitted. Unsupported/blank type becomes null and
        receives generic recommendations; it does not return422. Form summaries
        include standardized donor fields when enabled. Recommended IDs are
        suggestions and do not attach modules. Requires permission: one of
        programs_view, manage_programs, program-all.
      operationId: reference_Admin_ProgramController_programSetupOptions
      parameters:
        - name: type
          in: query
          description: Optional intended program behavior.
          required: false
          schema:
            type: string
            enum:
              - number
              - contribution
              - campaign
              - peer_to_peer
              - trips
          example: number
      responses:
        '200':
          description: Operation result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProgramSetupOptions'
        '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.
        '422':
          description: Request validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestRejection'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
      servers:
        - url: https://api.gratona.com/v1
          description: Gratona API
components:
  schemas:
    ProgramSetupOptions:
      properties:
        type:
          description: >-
            HTTP contracts traced from the deployed controller and delegated
            validation/serialization.
          type: string
          enum:
            - number
            - contribution
            - campaign
            - peer_to_peer
            - trips
            - null
          example: number
          nullable: true
        type_label:
          type: string
          example: Number of Sponsors
        recommended:
          properties:
            settings_id:
              description: Suggested or attached module identifier.
              type: integer
              example: 42
              nullable: true
            donor_hysform_id:
              description: Suggested or attached module identifier.
              type: integer
              example: 42
              nullable: true
            hysform_id:
              description: Suggested or attached module identifier.
              type: integer
              example: 42
              nullable: true
            emailset_id:
              description: Suggested or attached module identifier.
              type: integer
              example: 42
              nullable: true
            smsset_id:
              description: Suggested or attached module identifier.
              type: integer
              example: 42
              nullable: true
          type: object
        settings:
          type: array
          items:
            properties:
              id:
                type: integer
                example: 42
              name:
                type: string
                example: Education
              is_recommended:
                type: boolean
                example: false
              recommendation_reason:
                type: string
                example: Compatible program configuration.
              details:
                type: array
                items:
                  properties:
                    label:
                      type: string
                      example: Fields
                    value:
                      type: string
                      example: 12 total
                  type: object
              program_type:
                type: string
                enum:
                  - number
                  - contribution
                  - campaign
                  - peer_to_peer
                  - trips
                  - null
                example: number
                nullable: true
              program_type_label:
                type: string
                example: Number of Sponsors
              is_compatible:
                type: boolean
                example: true
              email_enabled:
                type: boolean
                example: true
              linked_programs_count:
                type: integer
                example: 1
            type: object
        forms:
          properties:
            donor:
              type: array
              items:
                properties:
                  id:
                    type: integer
                    example: 42
                  name:
                    type: string
                    example: Education
                  is_recommended:
                    type: boolean
                    example: false
                  recommendation_reason:
                    type: string
                    example: Compatible program configuration.
                  details:
                    type: array
                    items:
                      properties:
                        label:
                          type: string
                          example: Fields
                        value:
                          type: string
                          example: 12 total
                      type: object
                  type:
                    type: string
                    enum:
                      - donor
                      - entity
                    example: donor
                  fields_count:
                    type: integer
                    example: 12
                  required_fields_count:
                    type: integer
                    example: 3
                  public_fields_count:
                    type: integer
                    example: 8
                  standard_fields_count:
                    type: integer
                    example: 0
                  is_attachable:
                    type: boolean
                    example: true
                  field_preview:
                    type: array
                    items:
                      type: string
                      example: First name
                    maxItems: 4
                type: object
            entity:
              type: array
              items:
                properties:
                  id:
                    type: integer
                    example: 42
                  name:
                    type: string
                    example: Education
                  is_recommended:
                    type: boolean
                    example: false
                  recommendation_reason:
                    type: string
                    example: Compatible program configuration.
                  details:
                    type: array
                    items:
                      properties:
                        label:
                          type: string
                          example: Fields
                        value:
                          type: string
                          example: 12 total
                      type: object
                  type:
                    type: string
                    enum:
                      - donor
                      - entity
                    example: donor
                  fields_count:
                    type: integer
                    example: 12
                  required_fields_count:
                    type: integer
                    example: 3
                  public_fields_count:
                    type: integer
                    example: 8
                  standard_fields_count:
                    type: integer
                    example: 0
                  is_attachable:
                    type: boolean
                    example: true
                  field_preview:
                    type: array
                    items:
                      type: string
                      example: First name
                    maxItems: 4
                type: object
          type: object
        emailsets:
          type: array
          items:
            properties:
              id:
                type: integer
                example: 42
              name:
                type: string
                example: Education
              is_recommended:
                type: boolean
                example: false
              recommendation_reason:
                type: string
                example: Compatible program configuration.
              details:
                type: array
                items:
                  properties:
                    label:
                      type: string
                      example: Fields
                    value:
                      type: string
                      example: 12 total
                  type: object
              template_count:
                type: integer
                example: 4
              enabled_template_count:
                type: integer
                example: 4
              total_template_count:
                type: integer
                example: 5
              has_enabled_templates:
                type: boolean
                example: true
              trigger_preview:
                type: array
                items:
                  type: string
                  example: pay_receipt
                maxItems: 4
            type: object
        smssets:
          type: array
          items:
            properties:
              id:
                type: integer
                example: 42
              name:
                type: string
                example: Education
              is_recommended:
                type: boolean
                example: false
              recommendation_reason:
                type: string
                example: Compatible program configuration.
              details:
                type: array
                items:
                  properties:
                    label:
                      type: string
                      example: Fields
                    value:
                      type: string
                      example: 12 total
                  type: object
              template_count:
                type: integer
                example: 4
              trigger_preview:
                type: array
                items:
                  type: string
                  example: pay_remind
                maxItems: 4
            type: object
      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
    RequestRejection:
      description: >-
        Request or workflow rejection. Framework field-validation failures
        contain errors; semantic rejections may contain message without errors;
        legacy/provider failures may use error and error_code. The operation
        description identifies the rejected condition. Domain responses may add
        current revision, limits or other conflict context.
      anyOf:
        - $ref: '#/components/schemas/ValidationErrorResponse'
        - $ref: '#/components/schemas/ErrorResponse'
        - required:
            - error
          properties:
            error:
              description: Legacy or provider-facing error message.
              type: string
              example: The request could not be completed.
            error_code:
              description: Stable domain error code, when provided.
              type: string
              example: WORKFLOW_UNAVAILABLE
          type: object
    ValidationErrorResponse:
      title: ValidationErrorResponse
      description: >-
        Returned with HTTP 422 when `Validator::make($data, $rules)` fails. The
        `errors` map is keyed by the failing field name; each value is an array
        of human-readable error messages for that field. Most controllers also
        include a top-level `status: error`.
      required:
        - errors
      properties:
        errors:
          description: >-
            Map of field name to array of validator error messages. Example:
            `{email: [The email field is required.], amount: [The amount must be
            a number.]}`.
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        status:
          description: Always the literal string `error`.
          type: string
          example: error
        message:
          description: >-
            Optional summary message — present on some endpoints, absent on
            others.
          type: string
          example: The given data was invalid.
          nullable: true
      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
  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.