> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.sessionboard.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List orders

> Every order on the event, oldest first, with its lines, totals, payments, invoice and
the registrations it bought. Amounts are integers in the smallest currency unit
(cents).

Paginated (`page`, `page_size` up to 200). Requires `read:registrations` (legacy
tokens with no scopes pass).




## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/event/{eventId}/orders
openapi: 3.1.0
info:
  title: Sessionboard Public API
  version: '1.0'
  description: >-
    REST API for managing sessions, speakers, contacts, sponsors, exhibitors,
    and event data on the Sessionboard platform.
  contact:
    name: Sessionboard Support
    email: support@sessionboard.com
  termsOfService: https://www.sessionboard.com/legal/terms-of-service
servers:
  - url: https://public-api.sessionboard.com
    description: US Region
  - url: https://public-api-eu.sessionboard.com
    description: EU Region
security:
  - ApiKey: []
  - BearerToken: []
tags:
  - name: Events
    description: Manage events on the platform.
  - name: Sessions
    description: Search and retrieve sessions within an event.
  - name: Session Writes
    description: >-
      Create, update, delete, and restore sessions. Requires the
      `write:sessions` scope.
  - name: Contact Writes
    description: >-
      Create, update, delete, and restore contacts. Requires the
      `write:contacts` scope.
  - name: Exhibitor Writes
    description: >-
      Create, update, delete, and restore exhibitors. Requires the
      `write:exhibitors` scope.
  - name: Sponsor Writes
    description: >-
      Create, update, delete, and restore sponsors. Requires the
      `write:sponsors` scope.
  - name: Field Writes
    description: >-
      Create, update, and delete custom fields. Requires the `write:fields`
      scope.
  - name: Speakers
    description: Search and retrieve speakers within an event.
  - name: Participants
    description: |
      Search and retrieve every contact holding a session role on an event —
      speakers, chairpersons, moderators and custom roles — with the roles
      each one holds, and list the event's participant roles.
  - name: Contacts
    description: Search and retrieve contacts at the organization or event level.
  - name: Sponsors
    description: Search and retrieve sponsors within an event.
  - name: Exhibitors
    description: Search and retrieve exhibitors within an event.
  - name: Event Settings
    description: >-
      Retrieve event configuration such as fields, tags, tracks, rooms, formats,
      levels, languages, and session statuses.
  - name: GDPR
    description: Manage GDPR data access and erasure requests.
  - name: Insights
    description: >-
      Query event data using SbQL, generate queries with AI, and manage
      dashboards.
  - name: Ask
    description: >-
      Ask a natural-language question about one event and get a cited answer.
      Requires the `read:ask` scope, granted explicitly.
  - name: Metadata Writes
    description: >-
      Create, update, and delete session metadata (rooms, tracks, tags, formats,
      levels, languages, statuses). Requires the `write:metadata` scope.
  - name: Agenda Planning
    description: >-
      Manage agenda drafts, draft sessions, scheduling rules, and evaluation
      personas. Requires the `write:events` scope.
  - name: Dashboards & Widgets
    description: >-
      Create, read, update, and delete dashboards and widgets at the event or
      organization level. Requires `write:events` scope for writes.
  - name: Reports & Queries
    description: >-
      Create, read, update, delete, and run saved SbQL queries/reports at the
      event or organization level. Requires `write:events` scope for writes.
  - name: Transcriptions
    description: >-
      Transcript text on sessions — fragments, summaries, insights, and
      translations. Requires `read:transcriptions` / `write:transcriptions`
      scopes.
  - name: Session Recordings
    description: >-
      Session audio files for recording archives (live capture or imported
      audio). Requires `read:transcriptions` / `write:transcriptions` scopes.
  - name: Media
    description: >-
      Upload video or audio files for automatic transcription. Requires
      `read:media` / `write:media` scopes.
  - name: Session Files
    description: >
      Documents attached to sessions (PDFs, PowerPoint, Word, images, and
      similar).

      Simple upload: `POST .../files/upload` (multipart, max 50 MB).

      Direct-to-storage: create → PUT → complete (max 500 MB).

      Requires `read:sessions` / `write:sessions` scopes.

      See the [Uploading session files](/guides/uploading-session-files) guide.
  - name: OAuth
    description: >-
      OAuth 2.1 endpoints for AI client authorization (Claude, ChatGPT). Mounted
      at `/oauth/` (not `/v1/`).
  - name: Log Export
    description: >
      Pull your organization's API request, security and audit logs into a SIEM

      such as Splunk, Microsoft Sentinel or Elastic. Requires a dedicated API
      token

      with the `read:audit_logs` scope, which can call nothing else.

      See the [Exporting logs to a SIEM](/guides/exporting-logs-to-a-siem)
      guide.
  - name: Awards
    description: >-
      Read and manage Awards programs and their categories, rounds, promo codes,
      submissions and reviews. Organization-level: paths start at
      `/v1/organization/{orgId}/awards`. Requires `read:awards` / `write:awards`
      scopes.
  - name: Registration
    description: >
      Registration inside Sessionboard: registration forms, ticket types,
      registrations,

      orders, attendees and check-ins for one event. Requires the preview scopes

      `read:registrations` / `write:registrations`, which a token or OAuth
      client gets only

      when they are named explicitly (not by default, and not listed in
      `scopes_supported`).

      The event must have Registration turned on (Early Access); otherwise every
      endpoint

      answers `403 FORBIDDEN`.

      See the [Registration and Expo](/guides/registration-and-expo) guide.
  - name: Expo
    description: >
      Expo floor-map booths and sponsorship inventory for one event. Requires
      the preview

      scopes `read:expo` / `write:expo`, which a token or OAuth client gets only
      when they are

      named explicitly (not by default, and not listed in `scopes_supported`).
      The event must

      have Expo turned on (Early Access); otherwise every endpoint answers `403
      FORBIDDEN`.

      See the [Registration and Expo](/guides/registration-and-expo) guide.
paths:
  /v1/event/{eventId}/orders:
    get:
      tags:
        - Registration
      summary: List orders
      description: >
        Every order on the event, oldest first, with its lines, totals,
        payments, invoice and

        the registrations it bought. Amounts are integers in the smallest
        currency unit

        (cents).


        Paginated (`page`, `page_size` up to 200). Requires `read:registrations`
        (legacy

        tokens with no scopes pass).
      operationId: list-orders
      parameters:
        - $ref: '#/components/parameters/EventId'
        - $ref: '#/components/parameters/RegistrationPage'
        - $ref: '#/components/parameters/RegistrationPageSize'
        - name: status
          in: query
          required: false
          schema:
            type: string
          description: >
            Only these statuses, comma-separated: `draft`, `pending_payment`,

            `awaiting_invoice`, `paid`, `partially_refunded`, `refunded`,
            `canceled`,

            `expired`.
        - name: account_id
          in: query
          required: false
          schema:
            type: string
            format: uuid
          description: Only orders attached to this exhibitor or sponsor account.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Order'
                  pagination:
                    $ref: '#/components/schemas/ListPagination'
              example:
                data:
                  - id: 9e8d7c6b-5a4f-4e3d-2c1b-0a9f8e7d6c5b
                    number: R-1042
                    event_id: 7001
                    status: paid
                    purchaser:
                      type: contact
                      id: 1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e
                      email: events@northwind.example
                      name: Sam Ortiz
                      company: Northwind Health
                    currency: USD
                    subtotal_cents: 89500
                    discount_cents: 0
                    tax_cents: 0
                    total_cents: 89500
                    paid_cents: 89500
                    balance_cents: 0
                    payment_method: external
                    discount: null
                    lines:
                      - key: seat-0
                        line_item_id: 4f3e2d1c-0b9a-4876-a5b4-c3d2e1f0a9b8
                        ticket_type_id: 0b9d6a3c-2e1f-4a5b-9c8d-7e6f5a4b3c2d
                        type: ticket
                        label: Full conference
                        tier_label: null
                        quantity: 1
                        unit_price_cents: 89500
                        discount_cents: 0
                        tax_cents: 0
                        total_cents: 89500
                        attendee_index: 0
                        session_id: null
                        gl_code: null
                    registrations:
                      - id: 5d4c3b2a-1f0e-4d9c-8b7a-6f5e4d3c2b1a
                        status: confirmed
                        first_name: Priya
                        last_name: Raman
                        email: priya.raman@example.org
                        awaiting_assignment: false
                    invoice: null
                    form_id: 6c1f2d9e-3b4a-4f5e-8a7b-1c2d3e4f5a6b
                    account_id: null
                    payment_mode: external
                    created_at: '2026-10-02T16:21:40.000Z'
                pagination:
                  current_page: 1
                  page_size: 50
                  total_pages: 7
                  total_results: 318
        '401':
          $ref: '#/components/responses/RegistrationUnauthorized'
        '403':
          $ref: '#/components/responses/RegistrationForbidden'
        '429':
          $ref: '#/components/responses/RegistrationTooManyRequests'
components:
  parameters:
    EventId:
      name: eventId
      in: path
      required: true
      schema:
        type: integer
      description: Event ID
    RegistrationPage:
      name: page
      in: query
      required: false
      schema:
        type: integer
        minimum: 1
        default: 1
      description: >-
        Page number, from 1. A value that is not a positive integer is read as
        `1`.
    RegistrationPageSize:
      name: page_size
      in: query
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 200
        default: 50
      description: >-
        Results per page. Values above 200 are read as 200; a value that is not
        a positive integer is read as 50.
  schemas:
    Order:
      type: object
      description: An order and what it bought. Amounts are in the smallest currency unit.
      properties:
        id:
          type: string
          format: uuid
        number:
          type:
            - string
            - 'null'
          description: The order number shown to the purchaser and organizers.
        event_id:
          type: integer
        status:
          type: string
          enum:
            - draft
            - pending_payment
            - awaiting_invoice
            - paid
            - partially_refunded
            - refunded
            - canceled
            - expired
        purchaser:
          type: object
          properties:
            type:
              type:
                - string
                - 'null'
              enum:
                - contact
                - account
                - attendee
                - guest
                - null
            id:
              type:
                - string
                - 'null'
            email:
              type:
                - string
                - 'null'
            name:
              type:
                - string
                - 'null'
            company:
              type:
                - string
                - 'null'
        currency:
          type: string
        subtotal_cents:
          type: integer
        discount_cents:
          type: integer
        tax_cents:
          type: integer
        total_cents:
          type: integer
        paid_cents:
          type: integer
        balance_cents:
          type: integer
          description: '`total_cents - paid_cents`, never below `0`.'
        payment_method:
          type:
            - string
            - 'null'
          description: >-
            `card` for orders paid online; `comp`, `invoice`, `external`, `cash`
            or `check` for orders placed by organizers or through this API.
        discount:
          type:
            - object
            - 'null'
          properties:
            id:
              type: string
            code:
              type: string
        lines:
          type: array
          items:
            $ref: '#/components/schemas/OrderLine'
        registrations:
          type: array
          description: >-
            The registrations the order bought. Empty in the `order` returned by
            Create a registration — read `registrations` beside it.
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
              status:
                type: string
              first_name:
                type:
                  - string
                  - 'null'
              last_name:
                type:
                  - string
                  - 'null'
              email:
                type: string
              awaiting_assignment:
                type: boolean
        invoice:
          type:
            - object
            - 'null'
          additionalProperties: true
          description: The invoice, for orders paid by invoice.
        form_id:
          type:
            - string
            - 'null'
          format: uuid
        account_id:
          type:
            - string
            - 'null'
          format: uuid
        payment_mode:
          type:
            - string
            - 'null'
        created_at:
          type: string
          format: date-time
    ListPagination:
      type: object
      description: >-
        Pagination metadata returned by the event-settings GET lists (tags,
        tracks, levels, formats, rooms, languages, statuses). Same numbers as
        `Pagination`, snake_case keys — these endpoints are served by a
        different layer, and the casing is longstanding.
      properties:
        current_page:
          type: integer
          examples:
            - 1
        page_size:
          type: integer
          examples:
            - 25
        total_pages:
          type: integer
          examples:
            - 4
        total_results:
          type: integer
          examples:
            - 97
    OrderLine:
      type: object
      properties:
        key:
          type: string
        line_item_id:
          type: string
          format: uuid
        ticket_type_id:
          type:
            - string
            - 'null'
          format: uuid
        type:
          type:
            - string
            - 'null'
          description: The ticket type's `type` (`ticket`, `addon`, …).
        label:
          type:
            - string
            - 'null'
        tier_label:
          type:
            - string
            - 'null'
          description: The price tier applied (for example Early bird).
        quantity:
          type: integer
        unit_price_cents:
          type: integer
        discount_cents:
          type: integer
        tax_cents:
          type: integer
        total_cents:
          type: integer
        attendee_index:
          type:
            - integer
            - 'null'
          description: Which entry of the order's attendees this line is for.
        session_id:
          type:
            - string
            - 'null'
        gl_code:
          type:
            - string
            - 'null'
    RegistrationApiError:
      type: object
      description: Error body of the Registration and Expo endpoints.
      required:
        - error
        - message
      properties:
        error:
          type: string
          enum:
            - VALIDATION_ERROR
            - NOT_FOUND
            - FORBIDDEN
            - CONFLICT
            - SCOPE_REQUIRED
            - EVENT_NOT_ALLOWED
            - EVENT_ARCHIVED
            - INTERNAL_ERROR
        message:
          type: string
        details:
          type: object
          description: Present when there is a machine-readable reason.
          properties:
            reason:
              type: string
              description: >
                Why the request was refused, for example `duplicate`,
                `sold_out`, `too_many`,

                `ticket_unavailable`, `not_on_sale`,
                `registrant_type_unavailable`,

                `answers_invalid`, `discount_invalid`, `wrong_status`,
                `account_required` or

                `booth_not_found`.
            status:
              type: string
              description: >-
                For `wrong_status` on Check someone in, the registration's
                current status.
            errors:
              type: object
              additionalProperties: true
              description: >-
                More detail for some reasons — the email for `duplicate`, the
                `ticket_type_id` for `sold_out`, the problems per answer for
                `answers_invalid`.
  responses:
    RegistrationUnauthorized:
      description: >-
        Missing, invalid or expired token, or the event does not belong to your
        organization.
    RegistrationForbidden:
      description: >
        - `SCOPE_REQUIRED` — the token lacks the scope (`read:registrations` for
        reads, `write:registrations` for writes). A write scope does not grant
        reads, and legacy tokens with no scopes cannot write.

        - `EVENT_NOT_ALLOWED` — the event is outside the token's event
        allow-list.

        - `EVENT_ARCHIVED` — the event is archived.

        - `FORBIDDEN` — Registration is not turned on for this event.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RegistrationApiError'
          examples:
            feature_off:
              summary: Registration is off for the event
              value:
                error: FORBIDDEN
                message: Registration is not enabled for this event
            scope_required:
              summary: Token lacks the write scope
              value:
                error: SCOPE_REQUIRED
                message: This operation requires the 'write:registrations' scope.
    RegistrationTooManyRequests:
      description: |
        The token's request limit (100 requests per 15 minutes per bucket — see
        [Rate Limiting](/rate-limiting)). Wait `Retry-After` seconds.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: x-access-token
      description: >-
        Organization API token. Generate from Organization Settings → API
        Tokens.
    BearerToken:
      type: http
      scheme: bearer
      description: >-
        OAuth 2.1 access token. Obtained via the OAuth PKCE flow at
        `/oauth/token`.

````

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