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

# Get a booking form's import contract

> Returns every field a [booking import](/api-reference/endpoints/bookings/import-bookings) can fill for this booking form, with the rules the import checks each answer against.

The list covers the form's core fields and whether each is required, the ticket's custom questions, and the booker fields that apply to the whole booking. Each field says where its answer goes in an import row, the answer's shape, the keys of answers with several parts, and the exact option values the import accepts.



## OpenAPI

````yaml /openapi.json get /v0/booking-forms/{id}/import-fields
openapi: 3.1.0
info:
  title: Let's Do This API
  version: 0.1.0
  description: >
    The full reference — getting started, pagination, error responses, rate
    limits and the changelog — lives at

    [partner-help.letsdothis.com/api-reference](https://partner-help.letsdothis.com/api-reference/overview).

    This page is the interactive OpenAPI view of the same specification.


    # Authentication


    Create an API key from **Settings** → **Credentials** in your Let's Do This
    account and send it as a bearer token:


    ```bash

    curl --request GET \
     --url "https://api.letsdothis.com/v0/participants" \
     --header "Authorization: Bearer YOUR-API-KEY"
    ```


    Keep the key secret: it identifies your organization, so do not ship it in a
    website or native app. If a key is exposed,

    revoke it from the same section and create a replacement.


    # OpenAPI schema


    Download the [OpenAPI schema](https://api.letsdothis.com/documentation/json)
    to use with Postman or an OpenAPI client

    generator.
servers:
  - url: https://api.letsdothis.com
    description: Production
  - url: https://api.staging.letsdothis.com
    description: Staging
security:
  - bearerAuth: []
tags:
  - name: Events
    x-group: Events
    description: Events that participants can register for.
  - name: EventOccurrences
    x-group: Event occurrences
    description: >-
      Event occurrences scoped to the organizer associated with your Public API
      credentials. Unlike the public Events catalog, results are limited to your
      own events.
  - name: Races
    x-group: Races
    description: >-
      Races within an event occurrence. An event occurrence may have one or more
      races, for example a 5K and a 10K within the same race day.
  - name: Tickets
    x-group: Tickets
    description: Tickets that are available for events.
  - name: BookingForms
    x-group: Booking forms
    description: >-
      Booking forms define the questions a booker answers when registering for a
      ticket. A ticket usually references a single booking form, so expect zero
      or one, while a booking form may be shared across multiple tickets.
  - name: BookingFormFields
    x-group: Booking form fields
    description: >-
      Booking form fields are the individual questions on a booking form — their
      type, label, options, and whether an answer is required. A field can be
      reused across multiple forms.
  - name: Bookings
    x-group: Bookings
    description: >-
      Bookings are the transaction record for a registration. A booking may
      contain one or more participants (entries).
  - name: Membership
    x-group: Memberships
    description: >-
      Membership schemes, purchased policies and the seats on them, owned by
      your organizer. Policies are billing contracts; a seat is one person's
      place on a policy.
  - name: Participant
    x-group: Participants
    description: Participants are users who successfully booked an event.
  - name: LineItem
    x-group: Line items
    description: Financial details related to individual items within transactions.
  - name: AddOns
    x-group: Add-ons
    description: >-
      Your add-on products, such as merchandise or extras, that participants buy
      with their entry. Imported products keep the ids you gave them.
  - name: DiscountCodes
    x-group: Discount codes
    description: >-
      Discount codes participants enter at checkout to reduce the price of a
      booking.
  - name: Credits
    x-group: Credits
    description: >-
      Credits are balances participants can spend at checkout, identified by
      their email address.
  - name: Referrals
    x-group: Referrals
    description: >-
      Referral programs, the referrers registered on them, and asynchronous
      imports of historical referrals.
  - name: Teams
    x-group: Teams
    description: >-
      Teams group participants of an event occurrence under a team program.
      Teams can be imported for participants whose bookings were imported.
  - name: Application
    x-group: Applications
    description: >-
      Applications are created when a user applies for tickets that are set up
      to require an application process, such as balloted or "Good For Age"
      entries.
  - name: Partner
    x-group: Partners
    description: >-
      Partners that were created by the organization who can have Reserved
      Entries assigned to them.
  - name: ReservedEntries
    x-group: Reserved entries
    description: >-
      Reserved Entries are entries that are reserved for a partner. After being
      assigned, the partner can then allocate these entries to participants.
  - name: Timing
    x-group: Timing
    description: >-
      Timing providers push bib numbers and bib-pack shipments back to Let's Do
      This for the startlist entries they received. Available to select timing
      partners only.
  - name: Identity
    x-group: API key
    description: >-
      What your API key can reach. Available to every key, including scoped
      ones.
paths:
  /v0/booking-forms/{id}/import-fields:
    get:
      tags:
        - BookingFormFields
      summary: Get a booking form's import contract
      description: >-
        Returns every field a [booking
        import](/api-reference/endpoints/bookings/import-bookings) can fill for
        this booking form, with the rules the import checks each answer against.


        The list covers the form's core fields and whether each is required, the
        ticket's custom questions, and the booker fields that apply to the whole
        booking. Each field says where its answer goes in an import row, the
        answer's shape, the keys of answers with several parts, and the exact
        option values the import accepts.
      parameters:
        - schema:
            type:
              - number
              - 'null'
            minimum: 1
            maximum: 500
            example: 100
          in: query
          name: page[size]
          required: false
          description: How many results to return per page, from 1 to 500. Defaults to 100.
        - schema:
            type:
              - string
              - 'null'
          in: query
          name: page[after]
          required: false
          description: Pass `page.next` from the previous response to get the next page.
        - schema:
            type:
              - string
              - 'null'
          in: query
          name: page[before]
          required: false
          description: >-
            Pass `page.prev` from the previous response to get the previous
            page.
        - schema:
            type: string
          in: path
          name: id
          required: true
          description: The booking form's `id`.
      responses:
        '200':
          description: >-
            A page of the fields a booking import can fill for this form, each
            with the rules its answer must meet.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedBookingFormImportFields'
        '404':
          description: Not found. `message` says what's missing.
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                    enum:
                      - 404
                  error:
                    type: string
                  message:
                    type: string
components:
  schemas:
    PagedBookingFormImportFields:
      title: PagedBookingFormImportFields
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/BookingFormImportField'
        page:
          $ref: '#/components/schemas/PageCursor'
      required:
        - data
        - page
      additionalProperties: false
    BookingFormImportField:
      title: BookingFormImportField
      type: object
      properties:
        id:
          type: string
          description: The canonical id an import answer addresses this field by.
        name:
          type: string
          description: The default label of the field.
        type:
          type: string
          description: The type of the field.
        required:
          type: boolean
          description: >-
            Whether this form requires an answer to import a booking. One
            exception: a `WAIVER` field never blocks an import even when
            required — an omitted answer, or any value that is not a well-formed
            signing state, imports the waiver as unsigned. `required` on a
            waiver is the organiser asking you to supply the signing state; see
            **BookingImportFieldAnswer** for the waiver value format.
        importContract:
          $ref: '#/components/schemas/BookingFormFieldImportContract'
        publicId:
          type: string
          description: The field's non-unique public grouping key, when it has one.
      required:
        - id
        - name
        - type
        - required
        - importContract
      additionalProperties: false
      description: >-
        One row of a booking form's import contract: a field the import payload
        can (or must) answer, with everything needed to construct the answer.
      example:
        id: firstName
        name: First name
        type: TEXT
        required: true
        importContract:
          placement: participant
          answerShape: value
          readId: firstName
        publicId: participant-first-name
    PageCursor:
      title: PageCursor
      type: object
      properties:
        totalResults:
          type: number
          description: The total number of results available.
        first:
          type: string
          description: The cursor for the first page of results.
        last:
          type: string
          description: The cursor for the last page of results.
        prev:
          type: string
          description: The cursor for the previous page of results.
        next:
          type: string
          description: The cursor for the next page of results.
      required:
        - totalResults
        - first
        - last
        - prev
        - next
      additionalProperties: false
      description: >-
        Where you are in a paginated list.


        Pass `next` as `page[after]` to get the next page, or `prev` as
        `page[before]` to get the previous one. An empty cursor means there are
        no more pages in that direction. Treat cursors as opaque strings.
      example:
        totalResults: 506
        first: >-
          eyJpZCI6IjYzOTljMjAwMTVkNjBhZTNmZjI4ZjI0YyIsInVwZGF0ZWRBdCI6IjIwMjItMTItMTRUMTI6MzA6NTkuMjE3WiJ9
        last: >-
          eyJpZCI6IjY1NGNkZDIxZDlhMTU3ODdiNzFkMTM0YSIsInVwZGF0ZWRBdCI6IjIwMjMtMTEtMTNUMTU6MTE6MTIuNzI0WiJ9
        prev: ''
        next: >-
          eyJpZCI6IjY0NzBkNTkwM2RjOWE5OWJhMTA0Y2ZhYiIsInVwZGF0ZWRBdCI6IjIwMjMtMTEtMTNUMTU6MTE6MTIuNjE4WiJ9
    BookingFormFieldImportContract:
      title: BookingFormFieldImportContract
      type: object
      properties:
        placement:
          $ref: '#/components/schemas/ImportFieldPlacement'
        answerShape:
          $ref: '#/components/schemas/ImportAnswerShape'
        subKeys:
          type: array
          items:
            type: string
          description: >-
            Sub-ids for keyedValues answers (address sub-keys, group-select
            groups).
        optionValues:
          type: array
          items:
            type: string
          description: The exact tokens import validation accepts for choice fields.
        readId:
          type: string
          description: >-
            The id this field's answer surfaces under when reading bookings
            back, when it differs from the import id (e.g. `email` reads as
            `emailAddress`).
        format:
          type: string
          description: >-
            The accepted value pattern, for fields whose scalar has a strict
            shape (durations: `H:MM`, `M:SS`, or `H:MM:SS`).
        subKeyOptions:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: >-
            Per-sub-key accepted tokens for keyed composites that constrain them
            (group selects). Addresses accept free text and carry no entry.
        subKeyReadIds:
          type: object
          additionalProperties:
            type: string
          description: >-
            For keyed answers whose sub-answers surface as flat per-sub-key
            fields on booking reads (addresses): import sub-key → the field id
            it reads back under (e.g. `addressLineCity` → `addressCity`).
      required:
        - placement
        - answerShape
      additionalProperties: false
      description: >-
        How to express an answer for this field in an import payload, and how to
        find it again on booking reads.
      example:
        placement: participant
        answerShape: keyedValues
        subKeys:
          - addressLine1
          - addressLine2
          - addressLineCity
          - addressLineCounty
          - addressLineCountry
          - addressLinePostcode
    ImportFieldPlacement:
      title: ImportFieldPlacement
      type: string
      enum:
        - participant
        - booker
      description: Where an import answer for this field belongs in the import payload.
    ImportAnswerShape:
      title: ImportAnswerShape
      type: string
      enum:
        - value
        - values
        - keyedValues
      description: The slot an import answer for this field uses.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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