> ## 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. # List referral programs > Returns your referral programs — their ids, status, reward configuration, and covered event occurrences. Registered referrers are exposed through the separate, paginated referral-program referrers endpoint. This endpoint is restricted and not generally available: organizations that have not been enabled receive a `403`. Contact your Let's Do This representative if you'd like access. ## OpenAPI ````yaml /openapi.json get /v0/referral-programs 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/referral-programs: get: tags: - Referrals summary: List referral programs description: >- Returns your referral programs — their ids, status, reward configuration, and covered event occurrences. Registered referrers are exposed through the separate, paginated referral-program referrers endpoint. parameters: - schema: type: string in: query name: referralProgramId required: false description: Return one program. - schema: type: integer minimum: 1 maximum: 500 in: query name: page[size] required: false - schema: type: string in: query name: page[after] required: false - schema: type: string in: query name: page[before] required: false responses: '200': description: Default Response content: application/json: schema: $ref: '#/components/schemas/PagedReferralPrograms' components: schemas: PagedReferralPrograms: title: PagedReferralPrograms type: object properties: data: type: array items: $ref: '#/components/schemas/ReferralProgramSummary' page: $ref: '#/components/schemas/PageCursor' required: - data - page additionalProperties: false description: Your referral programs. example: data: - referralProgramId: 66f1a2b3c4d5e6f708192a3b name: City River Run Rewards status: ACTIVE rewardType: MILESTONE rewardRules: - type: MILESTONE threshold: 3 rewardAmount: value: 2500 currencyCode: USD eventOccurrenceIds: - 66a2b3c4d5e6f708192a3b4c page: totalResults: 1 first: cursor last: cursor prev: '' next: '' ReferralProgramSummary: title: ReferralProgramSummary type: object properties: referralProgramId: type: string description: The id of the referral program. name: type: string status: type: string enum: - DRAFT - ACTIVE - PAUSED - COMPLETED - CANCELLED description: >- Programs with status `ACTIVE`, `PAUSED`, or `COMPLETED` accept imported referral rows. rewardType: type: string enum: - MILESTONE - ROLLING description: >- How rewards accrue: `MILESTONE` pays at set thresholds; `ROLLING` pays every rolling block of referrals. rewardRules: type: array items: $ref: '#/components/schemas/ReferralProgramRewardRule' eventOccurrenceIds: type: array items: type: string description: >- The event occurrences the program covers. A participant must belong to one of these occurrences to act as the source of an imported referral. Referral import registers or reuses that source participant's code. required: - referralProgramId - name - status - rewardType - rewardRules - eventOccurrenceIds additionalProperties: false description: One of your referral programs, as referral imports resolve it. 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 ReferralProgramRewardRule: title: ReferralProgramRewardRule type: object properties: type: type: string enum: - MILESTONE - ROLLING description: How the rule accrues, matching the program's `rewardType`. threshold: type: integer description: >- The eligible-referral count the rule pays at. Imported referrals count toward it exactly like live ones. minimum: 1 rewardAmount: $ref: '#/components/schemas/Price' required: - type - threshold - rewardAmount additionalProperties: false description: One reward rule of a referral program. Price: title: Price type: object properties: value: $ref: '#/components/schemas/PriceValue' currencyCode: $ref: '#/components/schemas/CurrencyCode' required: - value - currencyCode additionalProperties: false description: >- A monetary value in 100x base unit format. For example, 1 GBP is represented as: _{ "value": 100, "currencyCode": "GBP" }_ And 5 cents are represented as: _{ "value": 5, "currencyCode": "USD" }_ PriceValue: title: PriceValue type: number description: >- A monetary value in 100x base unit format. For example, 1 GBP is represented as: 100, and 5 cents are represented as: 5 example: 5000 CurrencyCode: title: CurrencyCode type: string enum: - AUD - CAD - DKK - EUR - GBP - INR - MXN - PHP - USD - ZERO securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````