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

# Show what your API key can reach

> Describes the key used to make the call: the organization it belongs to and, for a [scoped key](/api-reference/scoped-keys), the event occurrences and endpoints it is limited to. Both lists are empty for a key with full access.

This is the one endpoint every key can call regardless of its scope, so a partner can confirm what they were given before integrating, and you can check a key's scope without opening the dashboard. The response describes the key only; it never includes the key itself or anything about participants.

The `endpoints` values are stable names such as `registrationStatus`, not URL paths. Each endpoint that supports scoped keys names its id on its own reference page.



## OpenAPI

````yaml /openapi.json get /identity
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.
  - name: Identity
    x-group: API key
    description: >-
      What your API key can reach. Available to every key, including scoped
      ones.
paths:
  /identity:
    get:
      tags:
        - Identity
      summary: Show what your API key can reach
      description: >-
        Describes the key used to make the call: the organization it belongs to
        and, for a [scoped key](/api-reference/scoped-keys), the event
        occurrences and endpoints it is limited to. Both lists are empty for a
        key with full access.


        This is the one endpoint every key can call regardless of its scope, so
        a partner can confirm what they were given before integrating, and you
        can check a key's scope without opening the dashboard. The response
        describes the key only; it never includes the key itself or anything
        about participants.


        The `endpoints` values are stable names such as `registrationStatus`,
        not URL paths. Each endpoint that supports scoped keys names its id on
        its own reference page.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Identity'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                description: Unauthorized
                type: object
                properties:
                  statusCode:
                    type: number
                    enum:
                      - 401
                  error:
                    type: string
                  message:
                    type: string
components:
  schemas:
    Identity:
      title: Identity
      anyOf:
        - $ref: '#/components/schemas/OrganizerIdentity'
        - $ref: '#/components/schemas/MarketplaceIdentity'
        - $ref: '#/components/schemas/TimingProviderIdentity'
    OrganizerIdentity:
      title: OrganizerIdentity
      type: object
      properties:
        organiserId:
          type: string
        eventOccurrenceIds:
          type: array
          items:
            type: string
          description: Event occurrences the key is restricted to; empty when unrestricted.
        endpoints:
          type: array
          items:
            type: string
          description: Endpoint ids the key is restricted to; empty when unrestricted.
      required:
        - organiserId
        - eventOccurrenceIds
        - endpoints
      additionalProperties: false
      description: >-
        What `GET /identity` tells a caller about their own API key.
        Deliberately a fixed shape: this is the one response a partner can
        always fetch, so it must describe the key's scope and nothing internal.
    MarketplaceIdentity:
      title: MarketplaceIdentity
      type: object
      properties:
        clientName:
          type: string
      required:
        - clientName
      additionalProperties: false
      description: Returned to marketplace credentials.
    TimingProviderIdentity:
      title: TimingProviderIdentity
      type: object
      properties:
        provider:
          type: string
      required:
        - provider
      additionalProperties: false
      description: Returned to timing-provider credentials.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````