> 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

# GetReferredFriendByContactId

# Package: referralProgram

# Namespace: ReferredFriends

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

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

## Introduction

Retrieves a referred friend by contact ID.

You can use `me` instead of a specific contact ID to get the referred friend for the current identity's contact.

---

## REST API

### Schema

```
 Method: getReferredFriendByContactId
 Description: Retrieves a referred friend by contact GUID.  You can use `me` instead of a specific contact GUID to get the referred friend for the current identity's contact.
 URL: https://www.wixapis.com/v1/referred-friends/contact/{contactId}
 Method: GET
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  contactId
 Method parameters: 
   param name: contactId | type:   none | required: true
 Return type: GetReferredFriendByContactIdResponse
  - 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 by Contact ID
```curl
curl -X GET \
  'https://www.wixapis.com/referral_friends/v1/referred-friends/contact/me?contactId=me' \
  -H 'Authorization: <AUTH>'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.referralProgram.ReferredFriends.getReferredFriendByContactId(contactId)
 Description: Retrieves a referred friend by contact GUID.  You can use `me` instead of a specific contact GUID to get the referred friend for the current identity's contact.
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  contactId
 Method parameters: 
   param name: contactId | type: string | description: Contact GUID or "me" to get the current identity's contact. | required: true
 Return type: PROMISE<GetReferredFriendByContactIdResponse>
  - 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: 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

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

async function getReferredFriendByContactId(contactId) {
  const response = await friends.getReferredFriendByContactId(contactId);
};
```

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

async function myGetReferredFriendByContactIdMethod(contactId) {
  const elevatedGetReferredFriendByContactId = auth.elevate(friends.getReferredFriendByContactId);
  const response = await elevatedGetReferredFriendByContactId(contactId);
}
```

### getReferredFriendByContactId (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 getReferredFriendByContactId(contactId) {
  const response = await myWixClient.friends.getReferredFriendByContactId(contactId);
};
```

---