---
title: "Get Referral Details"
method: GET
path: "/customer/referrals"
---

# Get Referral Details

`GET /customer/referrals`

Retrieves the stats of the referrals along with the unique referral code of a specific customer.

## Query parameters

- `mobile` string
- `email` string
- `external_id` string
- `id` integer
- `campaign_token` string
- `start_date` string, date
- `end_date` string, date
- `store_code` string
- `order_by` 'created_date' | 'amount' | 'valid_till'
- `sort_order` 'asc' | 'desc'
- `limit` integer
- `only_referral_code` boolean

## Response `200`

200

- object
  - `response` object
    - `status` object
      - `success` string
      - `code` integer
      - `message` string
    - `customer` object
      - `email` unknown
      - `mobile` string
      - `external_id` string
      - `firstname` string
      - `lastname` string
      - `referral_code` string
      - `invitees` object
        - `referral_type` object[]
          - `type` string
          - `invitee` object[]
            - `identifier` string
            - `name` string
            - `invited_on` string
            - `till` object
              - …
      - `referees` object
        - `referee` object[]
          - `event_type` string
          - `firstname` unknown
          - `lastname` unknown
          - `mobile` unknown
          - `email` unknown
          - `external_id` unknown
          - `added_on` string
      - `incentives` unknown[]
        - unknown
      - `item_status` object
        - `success` string
        - `code` integer
        - `message` string

## Other responses

- `400` — 400

---

[API](https://skmtc.net/capillarytech/apis/sample-api.md) · [All operations](https://skmtc.net/capillarytech/apis/sample-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/capillarytech/sample-api/versions/de241f2ed9b3/schema)