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

# Get a registration form

> One registration form, in the same shape as the list.

Requires `read:registrations` (legacy tokens with no scopes pass).




## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/event/{eventId}/registration/forms/{formId}
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}/registration/forms/{formId}:
    get:
      tags:
        - Registration
      summary: Get a registration form
      description: |
        One registration form, in the same shape as the list.

        Requires `read:registrations` (legacy tokens with no scopes pass).
      operationId: get-registration-form
      parameters:
        - $ref: '#/components/parameters/EventId'
        - name: formId
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: The registration form ID.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/RegistrationForm'
        '400':
          description: '`VALIDATION_ERROR` — `formId` is not a UUID.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegistrationApiError'
        '401':
          $ref: '#/components/responses/RegistrationUnauthorized'
        '403':
          $ref: '#/components/responses/RegistrationForbidden'
        '404':
          description: '`NOT_FOUND` — no such form on this event.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegistrationApiError'
        '429':
          $ref: '#/components/responses/RegistrationTooManyRequests'
components:
  parameters:
    EventId:
      name: eventId
      in: path
      required: true
      schema:
        type: integer
      description: Event ID
  schemas:
    RegistrationForm:
      type: object
      properties:
        id:
          type: string
          format: uuid
        event_id:
          type: integer
        name:
          type: string
        slug:
          type: string
        kind:
          type: string
          enum:
            - attendee
            - group
            - presenter
            - press
            - exhibitor_staff
            - custom
        status:
          type: string
          enum:
            - draft
            - open
            - closed
            - archived
        is_open_now:
          type: boolean
          description: >-
            `true` when `status` is `open` and now is between `opens_at` and
            `closes_at`.
        opens_at:
          type:
            - string
            - 'null'
          description: >-
            Local date and time in the form's `timezone`, without an offset (for
            example `2026-09-01T09:00:00`).
        closes_at:
          type:
            - string
            - 'null'
          description: Local date and time in the form's `timezone`, without an offset.
        timezone:
          type: string
          description: The event's IANA time zone; `UTC` when the event has none.
        audience:
          type: string
          enum:
            - public
            - invite_code
            - invite_list
            - hidden
        invite_code:
          type:
            - string
            - 'null'
          description: The code registrants enter when `audience` is `invite_code`.
        requires_code:
          type: boolean
        ticket_type_ids:
          type: array
          items:
            type: string
            format: uuid
          description: The ticket types sold on this form.
        registrant_type_ids:
          type: array
          items:
            type: string
            format: uuid
          description: >-
            The registrant types (for example Member, Non-member) this form
            offers.
        questions:
          type: array
          items:
            type: object
            additionalProperties: true
          description: The form's questions, in order.
        languages:
          type: array
          items:
            type: string
        translations:
          type: object
          additionalProperties: true
        settings:
          type: object
          additionalProperties: true
        counts:
          type: object
          properties:
            registrations:
              type: integer
              description: >-
                Registrations placed through the form, excluding canceled and
                transferred.
        sort_order:
          type:
            - integer
            - 'null'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    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.