---
title: "Get referral settings"
method: GET
path: "/referral_settings"
tags: ["Referral Settings"]
---

# Get referral settings

`GET /referral_settings`

## Request

- Base URL: `https://api.smile.io/v1`
- URL: `https://api.smile.io/v1/referral_settings`
- Auth: HTTP bearer

Retrieves the configuration for the account's referral program.

## Response `200`

The referral settings were successfully retrieved.

- object
  - `referral_settings` ReferralSettings
    - `status` 'active' | 'inactive': The status of the referral program.
    - `sender_reward` object: The reward that will be issued to a customer who successfully refers another individual to the loyalty program.
      - `name` string: The name of the reward.
      - `image` object: An image for the reward.
        - `url` string: The URL of the image.
        - `content_type` string, nullable: The MIME type of the image.
    - `receiver_reward` object: The reward that will be issued to an individual who is referred to and joins the loyalty program.
      - `name` string: The name of the reward.
      - `image` object: An image for the reward.
        - `url` string: The URL of the image.
        - `content_type` string, nullable: The MIME type of the image.

## Changes

- **2026-11-03** `d395a9f2b730`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/smile/apis/smile-io-rest-api/changes/referral_settings/get.md)

---

[API](https://skmtc.dev/smile/apis/smile-io-rest-api.md) - [All operations](https://skmtc.dev/smile/apis/smile-io-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/smile/apis/smile-io-rest-api/revisions/d395a9f2b730?raw)