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

# Get event setup selectors

> Returns event settings, programs/campaigns, up to 250 trips and designations, up to 500 recipient-group records, 50 cover images and 500 email templates. section=email_templates returns only the email template list. Sample trip-linked records are excluded. Requires event-view permission or a route-authorized Events role.



## OpenAPI

````yaml get /admin/events/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/events/setup-options:
    get:
      tags:
        - Events
      summary: Get event setup selectors
      description: >-
        Returns event settings, programs/campaigns, up to 250 trips and
        designations, up to 500 recipient-group records, 50 cover images and 500
        email templates. section=email_templates returns only the email template
        list. Sample trip-linked records are excluded. Requires event-view
        permission or a route-authorized Events role.
      operationId: EventController_setupOptions
      parameters:
        - name: section
          in: query
          description: Use email_templates for only email-template choices.
          required: false
          schema:
            type: string
            example: email_templates
          example: email_templates
      responses:
        '200':
          description: Get event setup selectors completed.
          content:
            application/json:
              schema:
                properties:
                  data:
                    properties:
                      event_settings:
                        type: array
                        items:
                          properties:
                            id:
                              description: Selected record ID.
                              type: integer
                              example: 42
                            value:
                              description: Selection value.
                              type: string
                              example: '42'
                            label:
                              description: Readable selection label.
                              type: string
                              example: Annual Gala
                            name:
                              description: Record name.
                              type: string
                              example: Example
                              nullable: true
                            program_settings:
                              description: Serialized settings JSON.
                              type: string
                              example: '{`program_type`:`events`}'
                          type: object
                      programs:
                        type: array
                        items:
                          properties:
                            id:
                              description: Selected record ID.
                              type: integer
                              example: 42
                            value:
                              description: Selection value.
                              type: string
                              example: '42'
                            label:
                              description: Readable selection label.
                              type: string
                              example: Annual Gala
                            name:
                              description: Record name.
                              type: string
                              example: Example
                              nullable: true
                            type:
                              description: Program record type.
                              type: string
                              example: Example
                              nullable: true
                            program_type:
                              description: Effective settings program type.
                              type: string
                              example: Example
                              nullable: true
                            setting_id:
                              description: Settings profile ID.
                              type: integer
                              example: 42
                              nullable: true
                          type: object
                      campaigns:
                        type: array
                        items:
                          properties:
                            id:
                              description: Selected record ID.
                              type: integer
                              example: 42
                            value:
                              description: Selection value.
                              type: string
                              example: '42'
                            label:
                              description: Readable selection label.
                              type: string
                              example: Annual Gala
                            name:
                              description: Record name.
                              type: string
                              example: Example
                              nullable: true
                            type:
                              description: Program record type.
                              type: string
                              example: Example
                              nullable: true
                            program_type:
                              description: Effective settings program type.
                              type: string
                              example: Example
                              nullable: true
                            setting_id:
                              description: Settings profile ID.
                              type: integer
                              example: 42
                              nullable: true
                          type: object
                      trips:
                        type: array
                        items:
                          properties:
                            id:
                              description: Selected record ID.
                              type: integer
                              example: 42
                            value:
                              description: Selection value.
                              type: string
                              example: '42'
                            label:
                              description: Readable selection label.
                              type: string
                              example: Annual Gala
                            name:
                              description: Record name.
                              type: string
                              example: Example
                              nullable: true
                            destination:
                              description: Trip destination.
                              type: string
                              example: Example
                              nullable: true
                            status:
                              description: Trip status.
                              type: string
                              example: active
                          type: object
                      designations:
                        type: array
                        items:
                          properties:
                            id:
                              description: Selected record ID.
                              type: integer
                              example: 42
                            value:
                              description: Selection value.
                              type: string
                              example: '42'
                            label:
                              description: Readable selection label.
                              type: string
                              example: Annual Gala
                            name:
                              description: Record name.
                              type: string
                              example: Example
                              nullable: true
                            program_id:
                              description: Owning recipient program.
                              type: integer
                              example: 42
                              nullable: true
                          type: object
                      recipient_groups:
                        type: array
                        items:
                          properties:
                            id:
                              description: Selected record ID.
                              type: integer
                              example: 42
                            value:
                              description: Selection value.
                              type: string
                              example: '42'
                            label:
                              description: Readable selection label.
                              type: string
                              example: Annual Gala
                            name:
                              description: Record name.
                              type: string
                              example: Example
                              nullable: true
                            program_id:
                              description: Owning recipient program.
                              type: integer
                              example: 42
                              nullable: true
                          type: object
                      cover_images:
                        type: array
                        items:
                          properties:
                            id:
                              description: Image upload ID.
                              type: integer
                              example: 42
                            label:
                              description: Image filename label.
                              type: string
                              example: cover.jpg
                            url:
                              description: Image URL.
                              type: string
                              example: https://example.org/cover.jpg
                            thumbnail_url:
                              description: Thumbnail or full-size fallback URL.
                              type: string
                              example: https://example.org/cover-thumb.jpg
                          type: object
                      email_templates:
                        type: array
                        items:
                          properties:
                            id:
                              description: Selected record ID.
                              type: integer
                              example: 42
                            value:
                              description: Selection value.
                              type: string
                              example: '42'
                            label:
                              description: Readable selection label.
                              type: string
                              example: Annual Gala
                            name:
                              description: Record name.
                              type: string
                              example: Example
                              nullable: true
                            subject:
                              description: Email subject.
                              type: string
                              example: Example
                              nullable: true
                            trigger:
                              description: Template trigger.
                              type: string
                              example: new_donor
                            emailset_id:
                              description: Owning email set.
                              type: integer
                              example: 42
                            donation_type:
                              description: Template variant.
                              type: string
                              example: default
                          type: object
                    type: object
                type: object
        '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'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    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.