> ## 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 program website launch context

> Returns setup/public-page readiness, current website settings, shared-setting information, additional gift routes, public URLs and Elements embed configuration. No setting access returns403; a missing program returns404. A trip program without a real attached trip has no public page or embed configuration. can_manage reports whether launch settings may be changed. Requires permission: one of programs_view, manage_programs, program-all.



## OpenAPI

````yaml get /admin/program/{program_id}/launch-context
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/{program_id}/launch-context:
    get:
      tags:
        - Programs
      summary: Get program website launch context
      description: >-
        Returns setup/public-page readiness, current website settings,
        shared-setting information, additional gift routes, public URLs and
        Elements embed configuration. No setting access returns403; a missing
        program returns404. A trip program without a real attached trip has no
        public page or embed configuration. can_manage reports whether launch
        settings may be changed. Requires permission: one of programs_view,
        manage_programs, program-all.
      operationId: reference_Admin_ProgramController_programLaunchContext
      parameters:
        - name: program_id
          in: path
          description: Program id in the current organization.
          required: true
          schema:
            type: integer
          example: 42
      responses:
        '200':
          description: Operation result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProgramLaunchContext'
        '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 program is missing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
      servers:
        - url: https://api.gratona.com/v1
          description: Gratona API
components:
  schemas:
    ProgramLaunchContext:
      properties:
        program:
          properties:
            id:
              type: integer
              example: 42
            client_id:
              type: integer
              example: 12
            name:
              type: string
              example: Education
            prefix:
              type: string
              nullable: true
            setting_id:
              type: integer
              nullable: true
            program_type:
              type: string
              nullable: true
            program_type_label:
              type: string
              example: Number of Sponsors
          type: object
        readiness:
          allOf:
            - $ref: '#/components/schemas/ProgramSetupState'
            - properties:
                completion:
                  properties:
                    complete:
                      type: integer
                      example: 5
                    required:
                      type: integer
                      example: 7
                  type: object
              type: object
        setting:
          properties:
            id:
              type: integer
              nullable: true
            name:
              type: string
              nullable: true
            linked_programs_count:
              type: integer
              example: 1
            linked_programs:
              type: array
              items:
                properties:
                  id:
                    type: integer
                    example: 42
                  name:
                    type: string
                    example: Education
                  prefix:
                    type: string
                    example: EDU
                    nullable: true
                type: object
            is_shared:
              type: boolean
              example: false
            can_manage:
              type: boolean
              example: true
            advanced_url:
              type: string
              example: /app/program-settings
            copy_on_save_default:
              type: boolean
              example: false
          type: object
        branding:
          properties:
            attribution_removed:
              type: boolean
              example: false
          type: object
        visual_settings:
          description: >-
            Saved launch options use legacy scalar/JSON encodings;
            payment_methods contains card/check/cash/wire_transfer booleans.
          type: object
          additionalProperties: true
        preview:
          properties:
            color_theme:
              required:
                - color
                - color_level
              properties:
                color:
                  type: string
                  example: indigo
                color_level:
                  type: integer
                  example: 600
              type: object
            organization_color_theme:
              required:
                - color
                - color_level
              properties:
                color:
                  type: string
                  example: indigo
                color_level:
                  type: integer
                  example: 600
              type: object
            check_payment_instructions:
              type: string
              example: Mail checks to the organization.
          type: object
        additional_gift_routing:
          $ref: '#/components/schemas/ProgramAdditionalGiftRouting'
        public_links:
          properties:
            base_url:
              type: string
              example: https://app.gratona.com
            primary_url:
              type: string
              nullable: true
            items:
              type: array
              items:
                properties:
                  key:
                    type: string
                    example: donation_page
                  label:
                    type: string
                    example: Donation Page
                  url:
                    type: string
                  description:
                    type: string
                type: object
            donor_login:
              type: string
            program_login:
              type: string
            recipient_portal_login:
              type: string
              nullable: true
          type: object
        embed:
          properties:
            smart:
              properties:
                recommended:
                  type: boolean
                  example: true
                config:
                  properties:
                    type:
                      type: string
                      enum:
                        - trip
                        - donation
                        - peer-to-peer
                        - sponsorship
                      example: sponsorship
                    clientId:
                      type: string
                      example: '12'
                    programId:
                      type: string
                      example: '42'
                    programSlug:
                      type: string
                      nullable: true
                    tripSlug:
                      type: string
                    baseUrl:
                      type: string
                      example: https://app.gratona.com
                    defaultAmount:
                      nullable: true
                    defaultFrequency:
                      type: string
                      nullable: true
                  type: object
                  nullable: true
                preview_url:
                  type: string
                  nullable: true
              type: object
          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
    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
    ProgramSetupState:
      properties:
        program_id:
          type: integer
          example: 42
        program_name:
          type: string
          example: Education
        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
        attached_modules:
          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
        email_required:
          type: boolean
          example: true
        steps:
          type: array
          items:
            properties:
              key:
                type: string
                example: donor_form
              label:
                type: string
                example: Donor form
              state:
                type: string
                enum:
                  - complete
                  - missing
                  - optional
                  - blocked
                example: complete
              next_action:
                type: string
                example: Attach a donor form
                nullable: true
            type: object
        next_step_key:
          type: string
          example: entity_form
          nullable: true
        is_launch_ready:
          type: boolean
          example: false
      type: object
    ProgramAdditionalGiftRouting:
      properties:
        allow_donor_choice:
          type: boolean
          example: true
        available_gifts:
          type: array
          items:
            properties:
              id:
                type: integer
                example: 42
              name:
                type: string
                example: School supplies
              code:
                type: string
                example: SUPPLIES
                nullable: true
            type: object
        target_entities:
          type: array
          items:
            $ref: '#/components/schemas/ProgramGiftTarget'
        target_entities_exist:
          type: boolean
          example: true
        routes:
          description: >-
            Gift designation ID to default recipient ID, or an empty list when
            no routes exist.
          oneOf:
            - type: object
              additionalProperties:
                type: integer
                nullable: true
            - type: array
              items: {}
              maxItems: 0
      type: object
    ProgramGiftTarget:
      properties:
        id:
          type: integer
          example: 42
        name:
          type: string
          example: Education fund
        program_id:
          type: integer
          example: 12
      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.