> ## Documentation Index
> Fetch the complete documentation index at: https://dev.smile.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get referral settings

> Retrieve an account's referral program settings in the Smile REST API.

export const scope_0 = "referral_settings:read"

<Callout icon="key" iconType="regular">
  This endpoint requires the **{scope_0}** scope.
</Callout>

If the account has not set up a referral program, a `404` response is returned.


## OpenAPI

````yaml schemas/rest-api.json GET /referral_settings
openapi: 3.1.0
info:
  title: Smile.io REST API
  version: 1.0.0
  description: A RESTful interface for interacting with Smile.io loyalty programs.
servers:
  - url: https://api.smile.io/v1
security:
  - bearerAuth: []
paths:
  /referral_settings:
    get:
      tags:
        - Referral Settings
      summary: Get referral settings
      description: Retrieves the configuration for the account's referral program.
      operationId: get__referral_settings
      responses:
        '200':
          description: The referral settings were successfully retrieved.
          content:
            application/json:
              schema:
                type: object
                properties:
                  referral_settings:
                    $ref: '#/components/schemas/ReferralSettings'
components:
  schemas:
    ReferralSettings:
      type: object
      properties:
        status:
          type: string
          enum:
            - active
            - inactive
          example: active
          description: The status of the referral program.
        sender_reward:
          type: object
          properties:
            name:
              type: string
              example: $5 off discount
              description: The name of the reward.
            image:
              type: object
              properties:
                url:
                  type: string
                  example: https://platform-images.smilecdn.co/3755938.png
                  description: The URL of the image.
                content_type:
                  type:
                    - string
                    - 'null'
                  example: image/png
                  description: The MIME type of the image.
              description: An image for the reward.
          description: >-
            The reward that will be issued to a customer who successfully refers
            another individual to the loyalty program.
        receiver_reward:
          type: object
          properties:
            name:
              type: string
              example: 5% off coupon
              description: The name of the reward.
            image:
              type: object
              properties:
                url:
                  type: string
                  example: https://platform-images.smilecdn.co/3755938.png
                  description: The URL of the image.
                content_type:
                  type:
                    - string
                    - 'null'
                  example: image/png
                  description: The MIME type of the image.
              description: An image for the reward.
          description: >-
            The reward that will be issued to an individual who is referred to
            and joins the loyalty program.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````