> 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

# GetReferredFriend

# Package: referralProgram

# Namespace: ReferredFriends

# Method link: https://dev.wix.com/docs/api-reference/business-management/marketing/referral-program/referred-friends/get-referred-friend.md

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

## Introduction

Retrieves a referred friend by ID.

---

## REST API

### Schema

```
 Method: getReferredFriend
 Description: Retrieves a referred friend by GUID.
 URL: https://www.wixapis.com/v1/referred-friends/{referredFriendId}
 Method: GET
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  referredFriendId
 Method parameters: 
   param name: referredFriendId | type:   none | required: true
 Return type: GetReferredFriendResponse
  - name: referredFriend | type: ReferredFriend | description: Retrieved referred friend. 
     - name: id | type: string | description: GUID of the referred friend. 
     - name: contactId | type: string | description: Contact GUID of the referred friend. 
     - name: referringCustomerId | type: string | description: GUID of the customer who referred this friend. 
     - name: status | type: Status | description: Status of the referred friend. 
         - enum:
         -     UNKNOWN: Unknown status.
         -     SIGN_UP_COMPLETED: Initial status when the referred friend joins the site as a member.
         -     ACTIONS_COMPLETED: Status after the referred friend completes a specific action, such as making a purchase.
     - name: revision | type: string | description: Revision number, which increments by 1 each time the referred friend is updated. To prevent conflicting changes, the current revision must be passed when updating the referred friend. 
     - name: createdDate | type: string | description: Date and time the referred friend was created. 
     - name: updatedDate | type: string | description: Date and time the referred friend was last updated. 


```

### Examples

### Get Referred Friend
```curl
curl -X GET \
  'https://www.wixapis.com/referral_friends/v1/referred-friends/3857d039-b129-4393-b983-947078b6a007' \
  -H 'Authorization: <AUTH>'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.referralProgram.ReferredFriends.getReferredFriend(referredFriendId)
 Description: Retrieves a referred friend by GUID.
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  referredFriendId
 Method parameters: 
   param name: referredFriendId | type: string | description: GUID of the referred friend to retrieve. | required: true
 Return type: PROMISE<ReferredFriend>
  - name: _id | type: string | description: GUID of the referred friend. 
  - name: contactId | type: string | description: Contact GUID of the referred friend. 
  - name: referringCustomerId | type: string | description: GUID of the customer who referred this friend. 
  - name: status | type: Status | description: Status of the referred friend. 
     - enum:
     -     UNKNOWN: Unknown status.
     -     SIGN_UP_COMPLETED: Initial status when the referred friend joins the site as a member.
     -     ACTIONS_COMPLETED: Status after the referred friend completes a specific action, such as making a purchase.
  - name: revision | type: string | description: Revision number, which increments by 1 each time the referred friend is updated. To prevent conflicting changes, the current revision must be passed when updating the referred friend. 
  - name: _createdDate | type: Date | description: Date and time the referred friend was created. 
  - name: _updatedDate | type: Date | description: Date and time the referred friend was last updated. 


```

### Examples

### getReferredFriend
```javascript
import { friends } from '@wix/referral';

async function getReferredFriend(referredFriendId) {
  const response = await friends.getReferredFriend(referredFriendId);
};
```

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

async function myGetReferredFriendMethod(referredFriendId) {
  const elevatedGetReferredFriend = auth.elevate(friends.getReferredFriend);
  const response = await elevatedGetReferredFriend(referredFriendId);
}
```

### getReferredFriend (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 { friends } from '@wix/referral';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

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


async function getReferredFriend(referredFriendId) {
  const response = await myWixClient.friends.getReferredFriend(referredFriendId);
};
```

---