> ## 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 a staff event order

> Returns the raw organization/event order, registration, attendees with ticket/table, promo code, and sponsor packages. Raw Eloquent monetary values are decimal strings; this differs from the management projection returned by mutation endpoints.



## OpenAPI

````yaml get /admin/events/{eventId}/orders/{orderId}
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/{eventId}/orders/{orderId}:
    get:
      tags:
        - Events
      summary: Get a staff event order
      description: >-
        Returns the raw organization/event order, registration, attendees with
        ticket/table, promo code, and sponsor packages. Raw Eloquent monetary
        values are decimal strings; this differs from the management projection
        returned by mutation endpoints.
      operationId: EventRegistrationController_show
      parameters:
        - name: eventId
          in: path
          description: Record ID in the authenticated organization.
          required: true
          schema:
            type: integer
            example: 42
          example: 42
        - name: orderId
          in: path
          description: Record ID in the authenticated organization.
          required: true
          schema:
            type: integer
            example: 42
          example: 42
      responses:
        '200':
          description: Get a staff event order completed.
          content:
            application/json:
              schema:
                properties:
                  data:
                    type: object
                    allOf:
                      - $ref: '#/components/schemas/EventApiOrder'
                      - properties:
                          registration:
                            properties:
                              id:
                                description: Registration ID.
                                type: integer
                                example: 42
                              client_id:
                                description: Organization ID.
                                type: integer
                                example: 42
                              event_id:
                                description: Event ID.
                                type: integer
                                example: 42
                              event_order_id:
                                description: Order ID.
                                type: integer
                                example: 42
                              purchaser_donor_id:
                                description: Donor ID.
                                type: integer
                                example: 42
                                nullable: true
                              status:
                                description: State.
                                type: string
                                example: active
                              registered_at:
                                description: Registration time.
                                type: string
                                format: date-time
                                example: '2026-10-20T12:00:00Z'
                                nullable: true
                              cancelled_at:
                                description: Cancellation time.
                                type: string
                                format: date-time
                                example: '2026-10-20T12:00:00Z'
                                nullable: true
                              notes:
                                description: Staff notes.
                                type: string
                                example: Example
                                nullable: true
                              created_at:
                                description: Created.
                                type: string
                                format: date-time
                                example: '2026-10-20T12:00:00Z'
                                nullable: true
                              updated_at:
                                description: Updated.
                                type: string
                                format: date-time
                                example: '2026-10-20T12:00:00Z'
                                nullable: true
                            type: object
                            nullable: true
                          attendees:
                            type: array
                            items:
                              type: object
                              allOf:
                                - $ref: '#/components/schemas/EventApiAttendee'
                                - properties:
                                    ticket_type:
                                      oneOf:
                                        - $ref: '#/components/schemas/EventApiTicketType'
                                        - type: string
                                          enum:
                                            - null
                                          nullable: true
                                    table:
                                      oneOf:
                                        - $ref: '#/components/schemas/EventApiTable'
                                        - type: string
                                          enum:
                                            - null
                                          nullable: true
                                  type: object
                          promo_code:
                            oneOf:
                              - $ref: '#/components/schemas/EventApiPromoCode'
                              - type: string
                                enum:
                                  - null
                                nullable: true
                          sponsors:
                            type: array
                            items:
                              type: object
                              allOf:
                                - $ref: '#/components/schemas/EventApiSponsor'
                                - properties:
                                    package:
                                      oneOf:
                                        - $ref: >-
                                            #/components/schemas/EventApiSponsorPackage
                                        - type: string
                                          enum:
                                            - null
                                          nullable: true
                                  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'
        '404':
          description: Resource not found in the organization or feature unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    EventApiOrder:
      properties:
        id:
          description: Id.
          type: integer
          example: 1
        client_id:
          description: Client id.
          type: integer
          example: 1
          nullable: false
        event_id:
          description: Event id.
          type: integer
          example: 1
          nullable: false
        purchaser_donor_id:
          description: Purchaser donor id.
          type: integer
          example: 1
          nullable: true
        promo_code_id:
          description: Promo code id.
          type: integer
          example: 1
          nullable: true
        donation_id:
          description: Donation id.
          type: integer
          example: 1
          nullable: true
        order_number:
          description: Order number.
          type: string
          example: Example
          nullable: false
        status:
          description: Status.
          type: string
          example: Example
          nullable: false
        payment_status:
          description: Payment status.
          type: string
          example: Example
          nullable: false
        payment_method:
          description: Payment method.
          type: string
          example: Example
          nullable: true
        gateway:
          description: Gateway.
          type: string
          example: Example
          nullable: true
        payment_intent_id:
          description: Payment intent id.
          type: string
          example: pi_example
          nullable: true
        transaction_id:
          description: Transaction id.
          type: string
          example: transaction_example
          nullable: true
        currency:
          description: Currency.
          type: string
          example: Example
          nullable: false
        subtotal_amount:
          description: Subtotal amount serialized as a decimal string.
          type: string
          example: '25.00'
          nullable: false
        discount_amount:
          description: Discount amount serialized as a decimal string.
          type: string
          example: '25.00'
          nullable: false
        fees_covered_amount:
          description: Fees covered amount serialized as a decimal string.
          type: string
          example: '25.00'
          nullable: false
        donation_amount:
          description: Donation amount serialized as a decimal string.
          type: string
          example: '25.00'
          nullable: false
        sponsorship_amount:
          description: Sponsorship amount serialized as a decimal string.
          type: string
          example: '25.00'
          nullable: false
        tax_deductible_amount:
          description: Tax deductible amount serialized as a decimal string.
          type: string
          example: '25.00'
          nullable: false
        non_deductible_amount:
          description: Non deductible amount serialized as a decimal string.
          type: string
          example: '25.00'
          nullable: false
        total_amount:
          description: Total amount serialized as a decimal string.
          type: string
          example: '25.00'
          nullable: false
        purchaser_name:
          description: Purchaser name.
          type: string
          example: Example
          nullable: true
        purchaser_email:
          description: Purchaser email.
          type: string
          example: Example
          nullable: true
        purchaser_phone:
          description: Purchaser phone.
          type: string
          example: Example
          nullable: true
        magic_token:
          description: Magic token.
          type: string
          example: Example
          nullable: false
        idempotency_key:
          description: Idempotency key.
          type: string
          example: Example
          nullable: true
        reservation_expires_at:
          description: Reservation expires at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        quote_fingerprint:
          description: Quote fingerprint.
          type: string
          example: Example
          nullable: true
        quote_snapshot:
          description: Quote snapshot.
          type: object
          nullable: true
          additionalProperties: true
        line_items:
          description: Line items.
          type: object
          nullable: true
          additionalProperties: true
        metadata:
          description: Metadata.
          type: object
          nullable: true
          additionalProperties: true
        receipt_snapshot:
          description: Receipt snapshot.
          type: object
          nullable: true
          additionalProperties: true
        paid_at:
          description: Paid at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        receipt_sent_at:
          description: Receipt sent at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        cancelled_at:
          description: Cancelled at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        created_at:
          description: Created at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        updated_at:
          description: Updated at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        deleted_at:
          description: Deleted at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        attendees_count:
          description: Attendee count when included by the event order list.
          type: integer
          example: 42
        promo_code:
          oneOf:
            - $ref: '#/components/schemas/EventApiPromoCode'
            - type: string
              enum:
                - null
              nullable: true
      type: object
    EventApiAttendee:
      properties:
        id:
          description: Id.
          type: integer
          example: 1
        client_id:
          description: Client id.
          type: integer
          example: 1
          nullable: false
        event_id:
          description: Event id.
          type: integer
          example: 1
          nullable: false
        event_registration_id:
          description: Event registration id.
          type: integer
          example: 1
          nullable: true
        event_order_id:
          description: Event order id.
          type: integer
          example: 1
          nullable: true
        event_ticket_type_id:
          description: Event ticket type id.
          type: integer
          example: 1
          nullable: true
        event_registration_group_id:
          description: Event registration group id.
          type: integer
          example: 1
          nullable: true
        donor_id:
          description: Donor id.
          type: integer
          example: 1
          nullable: true
        event_table_id:
          description: Event table id.
          type: integer
          example: 1
          nullable: true
        first_name:
          description: First name.
          type: string
          example: Example
          nullable: true
        last_name:
          description: Last name.
          type: string
          example: Example
          nullable: true
        email:
          description: Email.
          type: string
          example: Example
          nullable: true
        phone:
          description: Phone.
          type: string
          example: Example
          nullable: true
        status:
          description: Status.
          type: string
          example: Example
          nullable: false
        qr_token:
          description: Qr token.
          type: string
          example: Example
          nullable: false
        checked_in_at:
          description: Checked in at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        details_completed_at:
          description: Details completed at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        checked_in_by:
          description: Checked in by.
          type: integer
          example: 42
          nullable: true
        metadata:
          description: Metadata.
          type: object
          nullable: true
          additionalProperties: true
        created_at:
          description: Created at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        updated_at:
          description: Updated at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        deleted_at:
          description: Deleted at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        ticket_type:
          oneOf:
            - $ref: '#/components/schemas/EventApiTicketType'
            - type: string
              enum:
                - null
              nullable: true
        table:
          oneOf:
            - $ref: '#/components/schemas/EventApiTable'
            - type: string
              enum:
                - null
              nullable: true
        order:
          oneOf:
            - $ref: '#/components/schemas/EventApiOrder'
            - type: string
              enum:
                - null
              nullable: true
        registration_group:
          oneOf:
            - $ref: '#/components/schemas/EventApiRegistrationGroup'
            - type: string
              enum:
                - null
              nullable: true
        answers:
          type: array
          items:
            $ref: '#/components/schemas/EventApiAnswer'
      type: object
    EventApiTicketType:
      properties:
        id:
          description: Id.
          type: integer
          example: 1
        client_id:
          description: Client id.
          type: integer
          example: 1
          nullable: false
        event_id:
          description: Event id.
          type: integer
          example: 1
          nullable: false
        name:
          description: Name.
          type: string
          example: Annual Gala
          nullable: false
        code:
          description: Code.
          type: string
          example: Example
          nullable: true
        description:
          description: Description.
          type: string
          example: Example
          nullable: true
        price:
          description: Price serialized as a decimal string.
          type: string
          example: '25.00'
          nullable: false
        fair_market_value:
          description: Fair market value serialized as a decimal string.
          type: string
          example: '25.00'
          nullable: false
        quantity_available:
          description: Quantity available.
          type: integer
          example: 1
          nullable: true
        quantity_sold:
          description: Quantity sold.
          type: integer
          example: 1
          nullable: false
        quantity_reserved:
          description: Quantity reserved.
          type: integer
          example: 1
          nullable: false
        admissions_per_unit:
          description: Admissions per unit.
          type: integer
          example: 1
          nullable: false
        registration_group_kind:
          description: Registration group kind.
          type: string
          example: Example
          nullable: false
        group_label_prompt:
          description: Group label prompt.
          type: string
          example: Example
          nullable: true
        attendee_details_timing:
          description: Attendee details timing.
          type: string
          example: Example
          nullable: false
        waitlist_enabled:
          description: Waitlist enabled.
          type: boolean
          example: false
          nullable: false
        min_per_order:
          description: Min per order.
          type: integer
          example: 1
          nullable: false
        max_per_order:
          description: Max per order.
          type: integer
          example: 1
          nullable: true
        attendee_details_required:
          description: Attendee details required.
          type: boolean
          example: false
          nullable: false
        is_active:
          description: Is active.
          type: boolean
          example: false
          nullable: false
        visibility:
          description: Visibility.
          type: string
          enum:
            - public
            - private
          example: public
          nullable: false
        sale_starts_at:
          description: Sale starts at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        sale_ends_at:
          description: Sale ends at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        sort_order:
          description: Sort order.
          type: integer
          example: 1
          nullable: false
        settings:
          description: Settings.
          type: object
          nullable: true
          additionalProperties: true
        created_at:
          description: Created at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        updated_at:
          description: Updated at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        deleted_at:
          description: Deleted at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
      type: object
    EventApiTable:
      properties:
        id:
          description: Id.
          type: integer
          example: 1
        client_id:
          description: Client id.
          type: integer
          example: 1
          nullable: false
        event_id:
          description: Event id.
          type: integer
          example: 1
          nullable: false
        name:
          description: Name.
          type: string
          example: Annual Gala
          nullable: false
        section:
          description: Section.
          type: string
          example: Example
          nullable: true
        capacity:
          description: Capacity.
          type: integer
          example: 1
          nullable: false
        host_donor_id:
          description: Host donor id.
          type: integer
          example: 1
          nullable: true
        sort_order:
          description: Sort order.
          type: integer
          example: 1
          nullable: false
        notes:
          description: Notes.
          type: string
          example: Example
          nullable: true
        created_at:
          description: Created at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        updated_at:
          description: Updated at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        deleted_at:
          description: Deleted at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        attendees_count:
          description: Attendee count, included by the tables list.
          type: integer
          example: 42
      type: object
    EventApiPromoCode:
      properties:
        id:
          description: Id.
          type: integer
          example: 1
        client_id:
          description: Client id.
          type: integer
          example: 1
          nullable: false
        event_id:
          description: Event id.
          type: integer
          example: 1
          nullable: false
        code:
          description: Code.
          type: string
          example: Example
          nullable: false
        type:
          description: Type.
          type: string
          example: Example
          nullable: false
        value:
          description: Value serialized as a decimal string.
          type: string
          example: '25.00'
          nullable: false
        max_redemptions:
          description: Max redemptions.
          type: integer
          example: 1
          nullable: true
        redemptions_count:
          description: Redemptions count.
          type: integer
          example: 1
          nullable: false
        per_order_limit:
          description: Per order limit.
          type: integer
          example: 1
          nullable: true
        starts_at:
          description: Starts at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        ends_at:
          description: Ends at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        ticket_type_ids:
          description: Ticket type ids.
          type: array
          items:
            description: >-
              *. Referenced record must belong to the authenticated organization
              and this event.
            type: integer
            example: 1
          nullable: true
        sponsor_package_ids:
          description: Sponsor package ids.
          type: array
          items:
            description: >-
              *. Referenced record must belong to the authenticated organization
              and this event.
            type: integer
            example: 1
          nullable: true
        is_active:
          description: Is active.
          type: boolean
          example: false
          nullable: false
        created_at:
          description: Created at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        updated_at:
          description: Updated at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        deleted_at:
          description: Deleted at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
      type: object
    EventApiSponsor:
      properties:
        id:
          description: Id.
          type: integer
          example: 1
        client_id:
          description: Client id.
          type: integer
          example: 1
          nullable: false
        event_id:
          description: Event id.
          type: integer
          example: 1
          nullable: false
        event_sponsor_package_id:
          description: Event sponsor package id.
          type: integer
          example: 1
          nullable: true
        event_order_id:
          description: Event order id.
          type: integer
          example: 1
          nullable: true
        donor_id:
          description: Donor id.
          type: integer
          example: 1
          nullable: true
        company_name:
          description: Company name.
          type: string
          example: Example
          nullable: false
        contact_name:
          description: Contact name.
          type: string
          example: Example
          nullable: true
        contact_email:
          description: Contact email.
          type: string
          example: Example
          nullable: true
        contact_phone:
          description: Contact phone.
          type: string
          example: Example
          nullable: true
        logo_upload_id:
          description: Logo upload id.
          type: integer
          example: 1
          nullable: true
        status:
          description: Status.
          type: string
          example: Example
          nullable: false
        amount:
          description: Amount serialized as a decimal string.
          type: string
          example: '25.00'
          nullable: false
        fair_market_value:
          description: Fair market value serialized as a decimal string.
          type: string
          example: '25.00'
          nullable: false
        included_tickets_assigned:
          description: Included tickets assigned.
          type: integer
          example: 42
          nullable: false
        public_visibility:
          description: Public visibility.
          type: boolean
          example: false
          nullable: false
        notes:
          description: Notes.
          type: string
          example: Example
          nullable: true
        renewal_follow_up_at:
          description: Renewal follow up at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        created_at:
          description: Created at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        updated_at:
          description: Updated at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        deleted_at:
          description: Deleted at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        package:
          oneOf:
            - $ref: '#/components/schemas/EventApiSponsorPackage'
            - type: string
              enum:
                - null
              nullable: true
        donor:
          properties:
            id:
              description: Record ID in the authenticated organization.
              type: integer
              example: 42
            first_name:
              description: Donor first name.
              type: string
              example: Example
              nullable: true
            last_name:
              description: Donor last name.
              type: string
              example: Example
              nullable: true
            email:
              description: Donor email.
              type: string
              format: email
              example: jane@example.org
              nullable: true
          type: object
          nullable: true
        logo:
          properties:
            id:
              description: Record ID in the authenticated organization.
              type: integer
              example: 42
            name:
              description: Stored object key.
              type: string
              example: event-logo.png
            file_name:
              description: Original filename.
              type: string
              example: logo.png
          type: object
          nullable: true
        logo_url:
          description: Sponsor logo URL, included by sponsor list.
          type: string
          example: Example
          nullable: true
        deliverables:
          type: array
          items:
            $ref: '#/components/schemas/EventApiSponsorDeliverable'
        included_guests:
          description: Included by sponsor list.
          type: array
          items:
            properties:
              id:
                description: Guest attendee ID.
                type: integer
                example: 42
              name:
                description: Resolved guest name.
                type: string
                example: Example
                nullable: true
              first_name:
                description: Guest first name.
                type: string
                example: Example
                nullable: true
              last_name:
                description: Guest last name.
                type: string
                example: Example
                nullable: true
              email:
                description: Guest email.
                type: string
                example: Example
                nullable: true
              phone:
                description: Guest phone.
                type: string
                example: Example
                nullable: true
              status:
                description: Guest status.
                type: string
                example: Example
                nullable: true
              table:
                description: Table name.
                type: string
                example: Example
                nullable: true
              ticket_slot:
                description: Sponsor ticket slot.
                type: integer
                example: 42
                nullable: true
            type: object
      type: object
    EventApiSponsorPackage:
      properties:
        id:
          description: Id.
          type: integer
          example: 1
        client_id:
          description: Client id.
          type: integer
          example: 1
          nullable: false
        event_id:
          description: Event id.
          type: integer
          example: 1
          nullable: false
        name:
          description: Name.
          type: string
          example: Annual Gala
          nullable: false
        tier:
          description: Tier.
          type: string
          example: Example
          nullable: true
        description:
          description: Description.
          type: string
          example: Example
          nullable: true
        price:
          description: Price serialized as a decimal string.
          type: string
          example: '25.00'
          nullable: false
        fair_market_value:
          description: Fair market value serialized as a decimal string.
          type: string
          example: '25.00'
          nullable: false
        included_tickets:
          description: Included tickets.
          type: integer
          example: 1
          nullable: false
        included_tables:
          description: Included tables.
          type: integer
          example: 1
          nullable: false
        quantity_available:
          description: Quantity available.
          type: integer
          example: 1
          nullable: true
        quantity_sold:
          description: Quantity sold.
          type: integer
          example: 1
          nullable: false
        quantity_reserved:
          description: Quantity reserved.
          type: integer
          example: 1
          nullable: false
        visibility:
          description: Visibility.
          type: string
          enum:
            - public
            - private
          example: public
          nullable: false
        deliverables_template:
          description: Deliverables template.
          type: array
          items:
            type: string
          nullable: true
        settings:
          description: Settings.
          type: object
          nullable: true
          additionalProperties: true
        is_active:
          description: Is active.
          type: boolean
          example: false
          nullable: false
        sort_order:
          description: Sort order.
          type: integer
          example: 1
          nullable: false
        created_at:
          description: Created at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        updated_at:
          description: Updated at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        deleted_at:
          description: Deleted at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          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
    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
    EventApiRegistrationGroup:
      properties:
        id:
          description: Id.
          type: integer
          example: 1
        client_id:
          description: Client id.
          type: integer
          example: 1
          nullable: false
        event_id:
          description: Event id.
          type: integer
          example: 1
          nullable: false
        event_order_id:
          description: Event order id.
          type: integer
          example: 1
          nullable: false
        event_registration_id:
          description: Event registration id.
          type: integer
          example: 1
          nullable: true
        event_ticket_type_id:
          description: Event ticket type id.
          type: integer
          example: 1
          nullable: true
        event_sponsor_id:
          description: Event sponsor id.
          type: integer
          example: 1
          nullable: true
        source_kind:
          description: Source kind.
          type: string
          example: Example
          nullable: false
        source_id:
          description: Source id.
          type: integer
          example: 1
          nullable: false
        unit_index:
          description: Unit index.
          type: integer
          example: 1
          nullable: false
        kind:
          description: Kind.
          type: string
          example: Example
          nullable: false
        label:
          description: Label.
          type: string
          example: Example
          nullable: true
        admissions_reserved:
          description: Admissions reserved.
          type: integer
          example: 1
          nullable: false
        attendee_details_timing:
          description: Attendee details timing.
          type: string
          example: Example
          nullable: false
        status:
          description: Status.
          type: string
          example: Example
          nullable: false
        source_snapshot:
          description: Source snapshot.
          type: object
          nullable: false
          additionalProperties: true
        details_completed_at:
          description: Details completed at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        metadata:
          description: Metadata.
          type: object
          nullable: true
          additionalProperties: true
        created_at:
          description: Created at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        updated_at:
          description: Updated at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        deleted_at:
          description: Deleted at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        answers:
          type: array
          items:
            $ref: '#/components/schemas/EventApiAnswer'
      type: object
    EventApiAnswer:
      properties:
        id:
          description: Id.
          type: integer
          example: 1
        client_id:
          description: Client id.
          type: integer
          example: 1
          nullable: false
        event_id:
          description: Event id.
          type: integer
          example: 1
          nullable: false
        event_order_id:
          description: Event order id.
          type: integer
          example: 1
          nullable: true
        event_attendee_id:
          description: Event attendee id.
          type: integer
          example: 1
          nullable: true
        event_registration_group_id:
          description: Event registration group id.
          type: integer
          example: 1
          nullable: true
        event_question_id:
          description: Event question id.
          type: integer
          example: 1
          nullable: true
        answer:
          description: Answer.
          type: string
          example: Example
          nullable: true
        answer_json:
          description: Answer json.
          type: object
          nullable: true
          additionalProperties: true
        question_snapshot:
          description: Question snapshot.
          type: object
          nullable: true
          additionalProperties: true
        created_at:
          description: Created at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        updated_at:
          description: Updated at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        deleted_at:
          description: Deleted at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        question:
          oneOf:
            - $ref: '#/components/schemas/EventApiQuestion'
            - type: string
              enum:
                - null
              nullable: true
      type: object
    EventApiSponsorDeliverable:
      properties:
        id:
          description: Id.
          type: integer
          example: 1
        client_id:
          description: Client id.
          type: integer
          example: 1
          nullable: false
        event_id:
          description: Event id.
          type: integer
          example: 1
          nullable: false
        event_sponsor_id:
          description: Event sponsor id.
          type: integer
          example: 1
          nullable: false
        type:
          description: Type.
          type: string
          example: Example
          nullable: false
        label:
          description: Label.
          type: string
          example: Example
          nullable: false
        status:
          description: Status.
          type: string
          example: Example
          nullable: false
        due_at:
          description: Due at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        completed_at:
          description: Completed at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        completed_by:
          description: Completed by.
          type: integer
          example: 42
          nullable: true
        notes:
          description: Notes.
          type: string
          example: Example
          nullable: true
        created_at:
          description: Created at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        updated_at:
          description: Updated at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        deleted_at:
          description: Deleted at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
      type: object
    EventApiQuestion:
      properties:
        id:
          description: Id.
          type: integer
          example: 1
        client_id:
          description: Client id.
          type: integer
          example: 1
          nullable: false
        event_id:
          description: Event id.
          type: integer
          example: 1
          nullable: false
        scope:
          description: Scope.
          type: string
          example: Example
          nullable: false
        field_key:
          description: Field key.
          type: string
          pattern: ^[a-z0-9_\\\\-]+$
          example: dietary_preferences
          nullable: false
        field_label:
          description: Field label.
          type: string
          example: Dietary preferences
          nullable: false
        field_type:
          description: Field type.
          type: string
          example: Example
          nullable: false
        help_text:
          description: Help text.
          type: string
          example: Example
          nullable: true
        options:
          description: Options.
          type: array
          items:
            description: '*.'
            type: string
            maxLength: 255
            example: Example
          maxItems: 50
          nullable: true
        applies_to_ticket_type_ids:
          description: Applies to ticket type ids.
          type: array
          items:
            description: >-
              *. Referenced record must belong to the authenticated organization
              and this event.
            type: integer
            example: 1
          nullable: true
        required:
          description: Required.
          type: boolean
          example: false
          nullable: false
        is_active:
          description: Is active.
          type: boolean
          example: false
          nullable: false
        sort_order:
          description: Sort order.
          type: integer
          example: 1
          nullable: false
        created_at:
          description: Created at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        updated_at:
          description: Updated at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        deleted_at:
          description: Deleted at.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          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.