> ## 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 everything a `POST /v0/bookings/import` payload can address for this form: core fields with the form's requiredness, the ticket's custom questions, and the booking-level booker fields. Each row carries the import contract — where the answer belongs, its shape, sub-keys for keyed answers, and the exact option tokens accepted by import validation. Results are scoped to the organizer associated with your Public API credentials. ## 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: 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: >- Organizer-owned products that can be purchased and allocated to participants. Imported products retain stable external identities. - 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: 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. paths: /v0/booking-forms/{id}/import-fields: get: tags: - BookingFormFields summary: Get a booking form's import contract description: >- Returns everything a `POST /v0/bookings/import` payload can address for this form: core fields with the form's requiredness, the ticket's custom questions, and the booking-level booker fields. Each row carries the import contract — where the answer belongs, its shape, sub-keys for keyed answers, and the exact option tokens accepted by import validation. Results are scoped to the organizer associated with your Public API credentials. parameters: - schema: type: - number - 'null' minimum: 1 maximum: 500 example: 100 in: query name: page[size] required: false description: >- The number of entries to return per page. Range between 1 - 500, defaults to 100 - schema: type: - string - 'null' in: query name: page[after] required: false description: >- Accepts an existing page cursor. For more details see the definition of PageCursor in the response. - schema: type: - string - 'null' in: query name: page[before] required: false description: >- Accepts an existing page cursor. For more details see the definition of PageCursor in the response. - schema: type: string example: '67123' in: path name: id required: true description: The ID of the resource to query by responses: '200': description: Default Response content: application/json: schema: $ref: '#/components/schemas/PagedBookingFormImportFields' '404': description: Not found content: application/json: schema: description: Not found 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 description: >- When requesting a booking form's fields, the response is paginated. The data field contains **BookingFormImportField** objects — the form's full import contract, core fields included — and the page field contains a **PageCursor**. 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: >- **Cursor details for pagination**. - In scenarios with large amounts of data, it's common to return only a subset of data in a single request, known as a "page". - Most API responses include two objects: a 'data' object with the query results, and a 'PageCursor' object detailing the current page. - Cursors can be used to navigate to earlier or later pages in the set of results. For instance, passing the 'next' cursor from 'PageCursor' fetches the next set of results. - Cursors are base64 encoded 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 ````