> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# GetReferringCustomerByReferralCode

# Package: referralProgram

# Namespace: ReferringCustomers

# Method link: https://dev.wix.com/docs/api-reference/business-management/marketing/referral-program/referring-customers/get-referring-customer-by-referral-code.md

## Permission Scopes:
Manage Referrals: SCOPE.DC-REFERRALS.MANAGE-REFERRALS

## Introduction

Retrieves a referring customer by referral code.

---

## REST API

### Schema

```
 Method: getReferringCustomerByReferralCode
 Description: Retrieves a referring customer by referral code.
 URL: https://www.wixapis.com/v1/referring-customers/code/{referralCode}
 Method: GET
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  referralCode
 Method parameters: 
   param name: referralCode | type:   none | required: true
 Return type: GetReferringCustomerByReferralCodeResponse
  - name: referringCustomer | type: ReferringCustomer | description: Retrieved referring customer. 
     - name: id | type: string | description: GUID of the referring customer. 
     - name: contactId | type: string | description: Contact GUID associated with the referring customer. 
     - name: referralCode | type: string | description: Unique code for the referral. For example, `GxpxwAoMqxH8`. 
     - name: revision | type: string | description: Revision number, which increments by 1 each time the referring customer is updated. To prevent conflicting changes, the current revision must be passed when updating the referring customer. 
     - name: createdDate | type: string | description: Date and time the referring customer was created. 
     - name: updatedDate | type: string | description: Date and time the referring customer was last updated. 


```

### Examples

### Get Referring Customer by Referral Code
```curl
curl -X GET \
  'https://www.wixapis.com/referral-customers/v1/referring-customers/code/9zb9JvjwrvQF' \
    -H 'Authorization: <AUTH>' \
    -H 'Content-Type: application/json' \
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.referralProgram.ReferringCustomers.getReferringCustomerByReferralCode(referralCode)
 Description: Retrieves a referring customer by referral code.
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  referralCode
 Method parameters: 
   param name: referralCode | type: string | description: Referral code of the referring customer to retrieve. | required: true
 Return type: PROMISE<GetReferringCustomerByReferralCodeResponse>
  - name: referringCustomer | type: ReferringCustomer | description: Retrieved referring customer. 
     - name: _id | type: string | description: GUID of the referring customer. 
     - name: contactId | type: string | description: Contact GUID associated with the referring customer. 
     - name: referralCode | type: string | description: Unique code for the referral. For example, `GxpxwAoMqxH8`. 
     - name: revision | type: string | description: Revision number, which increments by 1 each time the referring customer is updated. To prevent conflicting changes, the current revision must be passed when updating the referring customer. 
     - name: _createdDate | type: Date | description: Date and time the referring customer was created. 
     - name: _updatedDate | type: Date | description: Date and time the referring customer was last updated. 


```

### Examples

### getReferringCustomerByReferralCode
```javascript
import { customers } from '@wix/referral';

async function getReferringCustomerByReferralCode(referralCode) {
  const response = await customers.getReferringCustomerByReferralCode(referralCode);
};
```

### getReferringCustomerByReferralCode (with elevated permissions)
```javascript
import { customers } from '@wix/referral';
import { auth } from '@wix/essentials';

async function myGetReferringCustomerByReferralCodeMethod(referralCode) {
  const elevatedGetReferringCustomerByReferralCode = auth.elevate(customers.getReferringCustomerByReferralCode);
  const response = await elevatedGetReferringCustomerByReferralCode(referralCode);
}
```

### getReferringCustomerByReferralCode (self-hosted)
Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).

```javascript
import { createClient } from '@wix/sdk';
import { customers } from '@wix/referral';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { customers },
  // Include the auth strategy and host as relevant
});


async function getReferringCustomerByReferralCode(referralCode) {
  const response = await myWixClient.customers.getReferringCustomerByReferralCode(referralCode);
};
```

---