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

# Quote public event registration

> Requires grouped-registration V2 to be enabled. Prices active available tickets/packages, promo discount, donation and optional fees in event currency; reserves no stock. Quote expires after five minutes. A waitlist offer credits pre-reserved matching ticket units. Check payment requires the event offline option and disables fee coverage.



## OpenAPI

````yaml post /frontend/public/events/{clientSlugOrId}/{eventSlug}/quote
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/public/events/{clientSlugOrId}/{eventSlug}/quote:
    post:
      tags:
        - Events
      summary: Quote public event registration
      description: >-
        Requires grouped-registration V2 to be enabled. Prices active available
        tickets/packages, promo discount, donation and optional fees in event
        currency; reserves no stock. Quote expires after five minutes. A
        waitlist offer credits pre-reserved matching ticket units. Check payment
        requires the event offline option and disables fee coverage.
      operationId: PublicEventController_quote
      parameters:
        - name: X-Event-Invitation
          in: header
          description: >-
            Invitation capability required to reach an invite-only event;
            invite_token input is an alternative.
          required: false
          schema:
            type: string
            example: issued-invitation-token
          example: issued-invitation-token
        - name: X-Event-Waitlist-Offer
          in: header
          description: >-
            An active waitlist offer can authorize the invite-only page;
            waitlist_offer_token input is an alternative.
          required: false
          schema:
            type: string
            example: issued-offer-token
          example: issued-offer-token
        - name: clientSlugOrId
          in: path
          description: Public organization slug or numeric ID.
          required: true
          schema:
            type: string
            example: example-foundation
          example: example-foundation
        - name: eventSlug
          in: path
          description: Event slug within the organization.
          required: true
          schema:
            type: string
            example: annual-gala
          example: annual-gala
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                tickets:
                  type: array
                  items:
                    required:
                      - ticket_type_id
                      - quantity
                    properties:
                      ticket_type_id:
                        description: >-
                          Active ticket type belonging to this event; public
                          requests require distinct IDs.
                        type: integer
                        example: 42
                      quantity:
                        description: >-
                          Units purchased; V2 public quote permits 1–50 and
                          product min/max also apply.
                        type: integer
                        maximum: 50
                        minimum: 1
                        example: 1
                    type: object
                  nullable: true
                sponsor_packages:
                  type: array
                  items:
                    required:
                      - sponsor_package_id
                      - quantity
                    properties:
                      sponsor_package_id:
                        description: >-
                          Package belonging to this event; public IDs must be
                          distinct.
                        type: integer
                        example: 42
                      quantity:
                        description: Package units.
                        type: integer
                        maximum: 20
                        minimum: 1
                        example: 1
                    type: object
                  nullable: true
                promo_code:
                  description: Active event promo code; validity/redemption limits apply.
                  type: string
                  maxLength: 80
                  example: WELCOME
                  nullable: true
                donation_amount:
                  description: >-
                    Optional donation add-on, suppressed when event settings
                    disable it.
                  type: number
                  maximum: 99999999.99
                  minimum: 0
                  example: 25
                  nullable: true
                cover_fees:
                  description: >-
                    Request server-calculated V2 fee coverage; ignored for check
                    payment.
                  type: boolean
                  example: false
                  nullable: true
                payment_method:
                  description: Selected payment method; check disables fee coverage.
                  type: string
                  enum:
                    - card
                    - paypal
                    - check
                    - offline
                    - cash
                    - free
                    - null
                  example: card
                  nullable: true
                currency:
                  description: Three-character hint; event currency determines the quote.
                  type: string
                  maxLength: 3
                  minLength: 3
                  example: USD
                  nullable: true
                waitlist_offer_token:
                  description: >-
                    Valid waitlist offer capability for the matching ticket and
                    exact offered quantity.
                  type: string
                  maxLength: 128
                  example: issued-offer-token
                  nullable: true
              type: object
      responses:
        '200':
          description: Quote public event registration completed.
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/EventApiRegistrationQuote'
                type: object
        '404':
          description: Organization, event, capability or registration unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
        '409':
          description: Inventory, quote, reservation or retry-key conflict.
          content:
            application/json:
              schema:
                properties:
                  message:
                    description: Error message.
                    type: string
                    example: Inventory, quote, reservation or retry-key conflict.
                  error_code:
                    description: Event domain error code.
                    type: string
                    example: invalid_reference
                  details:
                    description: Error-specific details.
                    type: object
                    additionalProperties: true
                type: object
        '422':
          description: >-
            Invalid cart, buyer form, question answers, payment configuration or
            registration window.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestRejection'
        '429':
          description: Public registration request limit exceeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security: []
components:
  schemas:
    EventApiRegistrationQuote:
      properties:
        quote_fingerprint:
          description: Five-minute fingerprint of products, totals and expiry.
          type: string
          example: >-
            sha256:1792497900:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
        expires_at:
          description: Quote expiry.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        currency:
          description: Event currency.
          type: string
          example: USD
        availability:
          properties:
            event_state:
              description: Event registration state.
              type: string
              example: open
            admissions_requested:
              description: Requested guest slots.
              type: integer
              example: 42
            admissions_remaining:
              description: Remaining slots; null means unbounded.
              type: integer
              example: 42
              nullable: true
          type: object
        lines:
          type: array
          items:
            properties:
              source:
                description: Product source.
                type: string
                enum:
                  - ticket
                  - sponsor_package
                example: ticket
              source_id:
                description: Ticket or package ID.
                type: integer
                example: 42
              label:
                description: Product label.
                type: string
                example: General admission
              units:
                description: Units.
                type: integer
                example: 42
              admissions_per_unit:
                description: Admissions per unit.
                type: integer
                example: 42
              admissions:
                description: Admissions.
                type: integer
                example: 42
              pre_reserved_units:
                description: Pre reserved units.
                type: integer
                example: 42
              unit_amount:
                description: Unit amount.
                type: string
                pattern: ^[0-9]+[.][0-9]{2}$
                example: '25.00'
              fair_market_value:
                description: Fair market value.
                type: string
                pattern: ^[0-9]+[.][0-9]{2}$
                example: '25.00'
              subtotal:
                description: Subtotal.
                type: string
                pattern: ^[0-9]+[.][0-9]{2}$
                example: '25.00'
              discount:
                description: Discount.
                type: string
                pattern: ^[0-9]+[.][0-9]{2}$
                example: '25.00'
              total:
                description: Total.
                type: string
                pattern: ^[0-9]+[.][0-9]{2}$
                example: '25.00'
              non_deductible:
                description: Non deductible.
                type: string
                pattern: ^[0-9]+[.][0-9]{2}$
                example: '25.00'
              snapshot:
                properties:
                  name:
                    description: Product name.
                    type: string
                    example: General admission
                  code:
                    description: Ticket code; null for packages.
                    type: string
                    example: Example
                    nullable: true
                  tier:
                    description: Package tier; null for tickets.
                    type: string
                    example: Example
                    nullable: true
                  registration_group_kind:
                    description: Group kind.
                    type: string
                    example: individual
                  group_label_prompt:
                    description: Prompt for naming this group.
                    type: string
                    example: Example
                    nullable: true
                  attendee_details_timing:
                    description: When guest details are needed.
                    type: string
                    enum:
                      - checkout
                      - before_event
                      - optional
                    example: checkout
                  admissions_per_unit:
                    description: Admission slots for one unit.
                    type: integer
                    example: 42
                  unit_amount:
                    description: Price of one unit.
                    type: string
                    pattern: ^[0-9]+[.][0-9]{2}$
                    example: '25.00'
                  fair_market_value:
                    description: Fair market value of one unit.
                    type: string
                    pattern: ^[0-9]+[.][0-9]{2}$
                    example: '25.00'
                type: object
            type: object
        promo_code_id:
          description: Applied promo ID.
          type: integer
          example: 42
          nullable: true
        promo_code:
          description: Applied promo code.
          type: string
          example: Example
          nullable: true
        subtotal:
          description: Subtotal.
          type: string
          pattern: ^[0-9]+[.][0-9]{2}$
          example: '25.00'
        discount:
          description: Discount.
          type: string
          pattern: ^[0-9]+[.][0-9]{2}$
          example: '25.00'
        fee_coverage:
          description: Fee coverage.
          type: string
          pattern: ^[0-9]+[.][0-9]{2}$
          example: '25.00'
        donation:
          description: Donation.
          type: string
          pattern: ^[0-9]+[.][0-9]{2}$
          example: '25.00'
        tax_deductible:
          description: Tax deductible.
          type: string
          pattern: ^[0-9]+[.][0-9]{2}$
          example: '25.00'
        non_deductible:
          description: Non deductible.
          type: string
          pattern: ^[0-9]+[.][0-9]{2}$
          example: '25.00'
        total:
          description: Total.
          type: string
          pattern: ^[0-9]+[.][0-9]{2}$
          example: '25.00'
        attendee_slots:
          description: Total admissions.
          type: integer
          example: 42
      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
    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
    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

````

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