> For the complete documentation index, see [llms.txt](https://village-labs.gitbook.io/coworker-product-and-developer-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://village-labs.gitbook.io/coworker-product-and-developer-docs/legacy-knowledge-base/referrals-connections.md).

# Referrals (Connections)

{% hint style="info" %}
[**Is this page helpful? Give us feedback on our docs ->**](/coworker-product-and-developer-docs/feedback/village-docs-feedback-form.md) [ ](/coworker-product-and-developer-docs/feedback/village-docs-feedback-form.md)
{% endhint %}

{% hint style="info" %} <mark style="color:blue;">**For Developers: : "Referrals" vs. "Connections" in the code**</mark>

**TL;DR - They're the same thing!**&#x20;

In the API code, we refer generically to connections and connection programs--not referrals and referral programs. That's because our Connections system is actually used to power more than just Referrals Programs. However in our Admin Dashboard, we mostly talk about "Referrals," which is the primary use case on that surface.&#x20;
{% endhint %}

## About Referrals&#x20;

Village's Referral programs are used to let you create up to 10 levels of connections between users.&#x20;

These "connections" may be used in [**Program Rules ->** ](/coworker-product-and-developer-docs/legacy-knowledge-base/programs-and-rules.md)to issue awards or comms to referrers when their referral completes an action, such as a signup.&#x20;

**For example:**&#x20;

<img src="https://3561055466-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fcl1KIMhPQkmG41x5eGvL%2Fuploads%2FznZsGJkIVGzf0Q4lEHQ7%2Ffile.excalidraw.svg?alt=media&amp;token=53148cc1-fe6e-447d-b030-3e1c6acad920" alt="Simple Referral Program Diagram" class="gitbook-drawing">

### Advanced Options: Multi-Level Connections & Tiered Referral Programs

Multi-level connections (aka tiered referral programs) allow you to issue awards and comms to not only a user's referrer, but also their referrer, and their referrer, and so on.&#x20;

If implemented and communicated correctly, this can generate huge buzz about your business and drive profitable growth.&#x20;

## Setting up a Referral Program

**Side Menu > Incentives > Referrals > Create New Referral.**&#x20;

Create a new referral type and set a unique referral code and signup link that your users will have access to.&#x20;

So that you can better track this code when new users sign up, we recommend accepting this variable referral code as a parameter in the URL.&#x20;

<figure><img src="https://3561055466-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fcl1KIMhPQkmG41x5eGvL%2Fuploads%2FCDZfZ4A0qbdxDT0SiM8n%2Fimage.png?alt=media&amp;token=d149702f-3433-4d9b-bf3d-18fddab42df7" alt=""><figcaption></figcaption></figure>

Setup&#x20;

<figure><img src="https://3561055466-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fcl1KIMhPQkmG41x5eGvL%2Fuploads%2FEbz9yxkgWnEcLOnRdVwP%2Fimage.png?alt=media&amp;token=eee34053-533b-4ef8-a830-d0f28c1ef066" alt=""><figcaption></figcaption></figure>

**Side Menu > Settings > Home Page Settings.** You can add users' special referral link to feature cards to better highlight and integrate your referral program into the end-user experience.&#x20;

<figure><img src="https://3561055466-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fcl1KIMhPQkmG41x5eGvL%2Fuploads%2FSTngoacZNpwc2QZdXlCQ%2Fimage.png?alt=media&amp;token=32a0b93c-1685-45f7-bac1-abb4836679c9" alt=""><figcaption></figcaption></figure>

**Side Menu > Settings > Home Page Settings.** You can add a special referral button at the top of the Earnings Widget on the end-user dashboard for any referral program.&#x20;

<figure><img src="https://3561055466-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fcl1KIMhPQkmG41x5eGvL%2Fuploads%2FDUYIhSn2n0T32jsLcRi3%2Fimage.png?alt=media&amp;token=a5c935d2-7670-4e2c-93f6-ced935f8e3b4" alt=""><figcaption></figcaption></figure>

You can customize the button text and the popup card using the Edit Referral Card feature in Home Page Settings.&#x20;

<figure><img src="https://3561055466-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fcl1KIMhPQkmG41x5eGvL%2Fuploads%2F2n7yEbNW7q2fayphKoEU%2Fimage.png?alt=media&amp;token=7f25fc9f-0483-47fe-8a62-0aca23b3b086" alt=""><figcaption></figcaption></figure>

An example of a simple referral card using markdown.&#x20;

<figure><img src="https://3561055466-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fcl1KIMhPQkmG41x5eGvL%2Fuploads%2FXuiJblhOnjoaU6bHJNat%2Fimage.png?alt=media&amp;token=e15bf63f-e36f-414f-8886-e834c977dbb9" alt=""><figcaption></figcaption></figure>

**End users can see their earnings based on each level of referral bonus:**&#x20;

<figure><img src="https://3561055466-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fcl1KIMhPQkmG41x5eGvL%2Fuploads%2F2pnDiRtDSAsliK4WFYTq%2Fimage.png?alt=media&amp;token=48bd7e25-5c03-4ff5-a1a4-5d7d6b443065" alt=""><figcaption></figcaption></figure>

**Rules for referral rewards are set up the same as normal Program Rules, but with the Recipient = the relevant referral connection:**&#x20;

<figure><img src="https://3561055466-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fcl1KIMhPQkmG41x5eGvL%2Fuploads%2FcBHZtDxDgLkzg5L6ZQcs%2Fimage.png?alt=media&amp;token=95778ed7-b773-4f38-a8df-573ea3084cfc" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://village-labs.gitbook.io/coworker-product-and-developer-docs/legacy-knowledge-base/referrals-connections.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
