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

# List event orders

> Returns newest event orders with attendee counts and promo-code summaries. Monetary values on raw order records are decimal strings. Requires events_finance, events_reports or events_manage.



## OpenAPI

````yaml get /admin/events/{eventId}/orders
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:
    get:
      tags:
        - Events
      summary: List event orders
      description: >-
        Returns newest event orders with attendee counts and promo-code
        summaries. Monetary values on raw order records are decimal strings.
        Requires events_finance, events_reports or events_manage.
      operationId: EventController_orders
      parameters:
        - name: eventId
          in: path
          description: Record ID in the authenticated organization.
          required: true
          schema:
            type: integer
            example: 42
          example: 42
        - name: page
          in: query
          description: One-based page.
          required: false
          schema:
            type: integer
            minimum: 1
            example: 1
          example: 1
        - name: per_page
          in: query
          description: Rows per page; clamped to 1–100.
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            example: 25
          example: 25
      responses:
        '200':
          description: List event orders completed.
          content:
            application/json:
              schema:
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/EventApiOrder'
                  meta:
                    properties:
                      current_page:
                        description: Current one-based page.
                        type: integer
                        example: 42
                      last_page:
                        description: Last page.
                        type: integer
                        example: 42
                      per_page:
                        description: Maximum rows per page.
                        type: integer
                        example: 42
                      total:
                        description: Total matching rows.
                        type: integer
                        example: 42
                    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
    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
    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
  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.