> ## 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 organization-scoped campaign checkout metadata

> Public campaign/program form metadata scoped by both organization and program. entity_mode=search returns only recipient options and paging metadata; initial returns bounded options with full form/configuration metadata, optionally adding a selected recipient beyond the limit; none omits recipients; options returns all projected options; full (and unknown modes) returns all raw recipient records. The search limit is clamped1–50, default24. trip_id can select a matching trip donor form. Standard donor field and public donation field contracts are returned only when their features/policies permit. Program progress is cached for30seconds. This metadata request does not create a donor or payment.



## OpenAPI

````yaml get /frontend/program/{client_id}/{program_id}/campaign
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:
  /frontend/program/{client_id}/{program_id}/campaign:
    get:
      tags:
        - Programs
      summary: Get organization-scoped campaign checkout metadata
      description: >-
        Public campaign/program form metadata scoped by both organization and
        program. entity_mode=search returns only recipient options and paging
        metadata; initial returns bounded options with full form/configuration
        metadata, optionally adding a selected recipient beyond the limit; none
        omits recipients; options returns all projected options; full (and
        unknown modes) returns all raw recipient records. The search limit is
        clamped1–50, default24. trip_id can select a matching trip donor form.
        Standard donor field and public donation field contracts are returned
        only when their features/policies permit. Program progress is cached
        for30seconds. This metadata request does not create a donor or payment.
      operationId: reference_Admin_ProgramController_getScopedCampaignProgramDetails
      parameters:
        - name: client_id
          in: path
          description: Client id in the current organization.
          required: true
          schema:
            type: integer
          example: 42
        - name: program_id
          in: path
          description: Program id in the current organization.
          required: true
          schema:
            type: integer
          example: 42
        - name: entity_mode
          in: query
          description: Recipient payload mode.
          required: false
          schema:
            type: string
            enum:
              - full
              - options
              - initial
              - search
              - none
          example: initial
        - name: entity_search
          in: query
          description: Recipient title search, trimmed and truncated to100characters.
          required: false
          schema:
            type: string
            maxLength: 100
          example: Education
        - name: entity_limit
          in: query
          description: Initial/search page size, clamped1–50.
          required: false
          schema:
            type: integer
            maximum: 50
            minimum: 1
          example: 24
        - name: selected_entity_id
          in: query
          description: An initial selection to include when it belongs to this program.
          required: false
          schema:
            type: integer
            minimum: 0
          example: 42
        - name: trip_id
          in: query
          description: Optional matching trip ID used to select its donor form.
          required: false
          schema:
            type: integer
            minimum: 0
          example: 42
      responses:
        '200':
          description: Operation result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicCampaignProgramDetails'
        '404':
          description: The organization/program is missing or not in the requested scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
        '422':
          description: Request validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestRejection'
      security: []
      servers:
        - url: https://api.gratona.com/v1
          description: Gratona API
components:
  schemas:
    PublicCampaignProgramDetails:
      oneOf:
        - required:
            - program
            - signup_fields
            - entities
            - program_progress
          properties:
            program:
              description: >-
                HTTP contracts traced from the deployed controller and delegated
                validation/serialization.
              type: array
              items:
                $ref: '#/components/schemas/Program'
            signup_fields:
              type: array
              items:
                properties:
                  field_key:
                    type: string
                    example: first_name
                  field_label:
                    type: string
                    example: First name
                  field_type:
                    type: string
                    example: hysText
                  field_data:
                    type: string
                    nullable: true
                  permissions:
                    type: string
                    example: public
                  required:
                    description: Legacy field required flag.
                type: object
                additionalProperties: true
            donation_fields:
              type: array
              items:
                properties:
                  field_key:
                    type: string
                  field_label:
                    type: string
                  field_type:
                    type: string
                  field_data:
                    type: string
                    nullable: true
                  permissions:
                    type: string
                    example: public
                  field_order:
                    type: integer
                  required:
                    description: Persisted required flag.
                  conditional_display_rule:
                    type: object
                    nullable: true
                    additionalProperties: true
                type: object
            entities:
              type: array
              items:
                properties:
                  id:
                    type: integer
                    example: 42
                  program_id:
                    type: integer
                    example: 12
                  entity_name:
                    properties:
                      id:
                        type: integer
                        example: 42
                      name:
                        type: string
                        example: Education fund
                      program_id:
                        type: integer
                        example: 12
                    type: object
                  is_featured:
                    type: boolean
                    example: false
                  designation_bio:
                    nullable: true
                  profilePic:
                    type: string
                    nullable: true
                  profileThumb:
                    type: string
                    nullable: true
                  profile_image:
                    type: string
                    nullable: true
                  json_fields:
                    description: >-
                      Only full mode includes the raw stored recipient field
                      payload.
                type: object
                additionalProperties: true
            additional_gifts:
              type: array
              items:
                properties:
                  id:
                    type: integer
                  name:
                    type: string
                  code:
                    type: string
                    nullable: true
                type: object
            program_progress:
              properties:
                program:
                  properties:
                    name:
                      type: string
                      example: Education
                  type: object
                total_amount:
                  description: >-
                    Rounded gift total for this program’s current recipients and
                    donor form.
                  type: number
                  example: 5000
                donation_count:
                  description: >-
                    Count of current donors in the program donor form, retained
                    under a legacy field name.
                  type: integer
                  example: 12
                settings:
                  type: object
                  nullable: true
                  additionalProperties: true
                currency:
                  type: string
                  example: $
              type: object
            entity_meta:
              properties:
                mode:
                  type: string
                  example: initial
                total:
                  description: Search mode returns null; initial mode computes the total.
                  type: integer
                  example: 100
                  nullable: true
                limit:
                  type: integer
                  example: 24
                has_more:
                  type: boolean
                  example: true
                search:
                  type: string
                  example: Education
              type: object
            client:
              $ref: '#/components/schemas/Client'
            show_standardized_fields:
              type: boolean
              example: true
            visible_standard_field_keys:
              type: array
              items:
                type: string
            required_standard_field_keys:
              type: array
              items:
                type: string
            standard_field_contract:
              properties:
                version:
                  type: integer
                  example: 1
                policy_revision:
                  type: string
                  example: '1:0'
                fields:
                  type: array
                  items:
                    properties:
                      key:
                        type: string
                        example: first_name
                      label:
                        type: string
                        example: First name
                      group:
                        type: string
                        example: identity
                      applies_to:
                        type: array
                        items:
                          type: string
                      presentation:
                        type: string
                        example: input
                      source_keys:
                        type: array
                        items:
                          type: string
                    type: object
                visible_input_keys:
                  type: array
                  items:
                    type: string
                required_input_keys:
                  type: array
                  items:
                    type: string
                visible_input_keys_by_donor_type:
                  type: object
                  additionalProperties:
                    type: array
                    items:
                      type: string
                required_input_keys_by_donor_type:
                  type: object
                  additionalProperties:
                    type: array
                    items:
                      type: string
                system_value_keys:
                  type: array
                  items:
                    type: string
                email_required:
                  type: boolean
                  example: false
                email_requirement_reason:
                  type: string
                  nullable: true
              type: object
            meta_pixel:
              properties:
                id:
                  type: string
                  nullable: true
                enabled:
                  type: boolean
                  example: false
                currency_symbol:
                  type: string
                  example: $
                currency_code:
                  type: string
                  example: USD
              type: object
          type: object
        - required:
            - client_id
            - program_id
            - entities
            - entity_meta
          properties:
            client_id:
              type: integer
              example: 12
            program_id:
              type: integer
              example: 42
            entities:
              type: array
              items:
                properties:
                  id:
                    type: integer
                    example: 42
                  program_id:
                    type: integer
                    example: 12
                  entity_name:
                    properties:
                      id:
                        type: integer
                        example: 42
                      name:
                        type: string
                        example: Education fund
                      program_id:
                        type: integer
                        example: 12
                    type: object
                  is_featured:
                    type: boolean
                    example: false
                  designation_bio:
                    nullable: true
                  profilePic:
                    type: string
                    nullable: true
                  profileThumb:
                    type: string
                    nullable: true
                  profile_image:
                    type: string
                    nullable: true
                  json_fields:
                    description: >-
                      Only full mode includes the raw stored recipient field
                      payload.
                type: object
                additionalProperties: true
            entity_meta:
              properties:
                mode:
                  type: string
                  example: initial
                total:
                  description: Search mode returns null; initial mode computes the total.
                  type: integer
                  example: 100
                  nullable: true
                limit:
                  type: integer
                  example: 24
                has_more:
                  type: boolean
                  example: true
                search:
                  type: string
                  example: Education
              type: object
          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
    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
    Program:
      title: Program
      description: >-
        A program (a.k.a. campaign) groups entities, donor profile forms,
        settings, and email/SMS template sets. Programs form a hierarchy via the
        Cartalyst nested-set pattern (`lft`/`rgt`/`tree`). The two HysForm
        references differentiate the donor profile form (`donor_hysform_id`)
        from the entity / sponsorship profile form (`hysform_id`).
      required:
        - id
        - client_id
        - name
      properties:
        id:
          description: Internal program ID.
          type: integer
          format: int64
          example: 11
        client_id:
          description: Owning Gratona client.
          type: integer
          format: int64
          example: 207
        name:
          description: Human-readable program name.
          type: string
          example: Child Sponsorship 2026
        type:
          description: >-
            Program type — `sponsorship`, `contribution`, `number of sponsors`,
            `campaign`, etc. Determines which UI flows are available.
          type: string
          example: Contribution
          nullable: true
        prefix:
          description: Receipt / commitment number prefix.
          type: string
          example: CS-2026
          nullable: true
        link_id:
          description: >-
            Optional parent program ID; used for sub-program linking outside the
            nested-set tree.
          type: integer
          format: int64
          example: null
          nullable: true
        hysform_id:
          description: >-
            HysForm defining the entity (recipient) profile fields for this
            program.
          type: integer
          format: int64
          example: 42
        donor_hysform_id:
          description: >-
            HysForm defining the donor profile fields for donors signing up
            under this program.
          type: integer
          format: int64
          example: 43
        setting_id:
          description: >-
            Settings record holding program-specific configuration (display
            options, public page copy, etc.).
          type: integer
          format: int64
          example: 87
          nullable: true
        emailset_id:
          description: Email template set used for automated emails on this program.
          type: integer
          format: int64
          example: 14
          nullable: true
        smsset_id:
          description: SMS template set used for automated SMS on this program.
          type: integer
          format: int64
          example: null
          nullable: true
        lft:
          description: >-
            Nested-set left boundary (Cartalyst). Used for tree ordering — do
            not edit directly.
          type: integer
          example: 1
        rgt:
          description: Nested-set right boundary (Cartalyst).
          type: integer
          example: 8
        tree:
          description: Nested-set tree id.
          type: integer
          example: 1
        created_at:
          type: string
          format: date-time
          example: '2025-01-01T00:00:00Z'
        updated_at:
          type: string
          format: date-time
          example: '2025-12-31T23:00:00Z'
        deleted_at:
          type: string
          format: date-time
          example: null
          nullable: true
      type: object
    Client:
      title: Client
      description: >-
        A Gratona client — the tenant of the multi-tenant system. Owns donors,
        entities, programs, users, and integrations. The `client_id` on every
        other resource scopes data to this row. Stripe Connect onboarding state,
        account-level settings, and the client's display name all live here.
      required:
        - id
        - organization
      properties:
        id:
          description: Internal client ID — referenced by every multi-tenant resource.
          type: integer
          format: int64
          example: 207
        organization:
          description: Display name of the organization.
          type: string
          example: Gratona Demo Org
        website:
          description: Organization website.
          type: string
          example: https://demo.gratona.com
          nullable: true
        email:
          description: Primary contact email for the organization.
          type: string
          format: email
          example: hello@demo.gratona.com
          nullable: true
        stripe_connect_id:
          description: >-
            Stripe Connect account id once onboarding completes; null until the
            org has finished Stripe onboarding.
          type: string
          example: acct_1OqXXXXX
          nullable: true
        previous_stripe_connect_id:
          description: >-
            Prior Stripe Connect account id, kept around when the client
            migrates between Connect accounts.
          type: string
          example: null
          nullable: true
        completed_stripe_onboarding:
          description: >-
            Whether the org has finished the Stripe Connect onboarding flow and
            can accept Stripe payments.
          type: boolean
          example: true
        date_format:
          description: >-
            Stored organization date-format setting token. API and admin
            surfaces resolve this token to the corresponding display pattern.
          type: string
          enum:
            - m-d-Y
            - d-m-Y
            - Y-m-d
          example: Y-m-d
        timezone:
          description: 'Computed accessor: client timezone derived from settings.'
          type: string
          example: America/Chicago
          nullable: true
        custom:
          description: >-
            Legacy free-form JSON column for arbitrary client-level
            configuration.
          type: object
          nullable: true
          additionalProperties: true
        frequency:
          description: Legacy frequency configuration for billing / payment plans (JSON).
          type: object
          nullable: true
          additionalProperties: true
        custom_start_date:
          description: Legacy billing custom start date marker.
          type: string
          example: null
          nullable: true
        custom_amount:
          description: Legacy billing custom amount marker.
          type: number
          format: float
          example: null
          nullable: true
        created_at:
          type: string
          format: date-time
          example: '2024-06-01T12:00:00Z'
        updated_at:
          type: string
          format: date-time
          example: '2026-01-01T00:00:00Z'
      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

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.