> ## Documentation Index
> Fetch the complete documentation index at: https://docs.equa.cc/llms.txt
> Use this file to discover all available pages before exploring further.

# Referral Endpoints

> Referral links, rewards, EquaCash, and invitation management

> **Source:** `equa-server/modules/api/src/endpoints/referral-endpoints.ts`

# Referral Endpoints

Endpoints for managing referrals, invitation emails, reward cards, EquaCash balances, and transfer history.

Most referral endpoints require authentication.

## Referrals

### Get Referrals

```
GET /v1/referral/:entity
```

| Field | Value    |
| ----- | -------- |
| Auth  | Required |

Get referral data for a specific entity.

***

### Get Organization Referrals

```
GET /v1/organization/:entity/referral
```

| Field | Value    |
| ----- | -------- |
| Auth  | Required |

Get EquaCash balance and referral summary for an organization member.

***

### Submit Company Info

```
POST /v1/referral/company
```

| Field | Value    |
| ----- | -------- |
| Auth  | Required |

Submit company information for a referral.

***

## Invitations

### Get Invitations

```
GET /v1/invitation
```

| Field | Value    |
| ----- | -------- |
| Auth  | Required |

List all invitations sent by the authenticated user.

***

### Send Invitation Email

```
POST /v1/invitation/send
```

| Field | Value    |
| ----- | -------- |
| Auth  | Required |

Send a referral invitation email.

**Request:**

```json theme={null}
{
  "email": "friend@example.com",
  "message": "Check out Equa for cap table management!"
}
```

***

## Rewards

### Get Rewards

```
GET /v1/card
```

| Field | Value    |
| ----- | -------- |
| Auth  | Required |

List all reward cards for the authenticated user.

***

### Reveal Reward Card

```
POST /v1/reward
```

| Field | Value    |
| ----- | -------- |
| Auth  | Required |

Reveal (scratch) a reward card to see its value.

**Request:**

```json theme={null}
{
  "rewardId": "uuid"
}
```

***

## EquaCash

### Transfer EquaCash

```
POST /v1/equaCash/transfer
```

| Field | Value    |
| ----- | -------- |
| Auth  | Required |

Transfer EquaCash between entities.

**Request:**

```json theme={null}
{
  "fromEntity": "uuid",
  "toEntity": "uuid",
  "amount": 50
}
```

***

### Get Transfer History

```
GET /v1/entity/:entity/history
```

| Field | Value    |
| ----- | -------- |
| Auth  | Required |

Get EquaCash transfer history for an entity.

***

## Google Contacts

### Get Google Contacts

```
GET /v1/google
```

| Field | Value    |
| ----- | -------- |
| Auth  | Required |

Retrieve Google contacts for the invitation flow.

***

## Waitlist Stats

### Get Waitlist Stats

```
GET /v1/waitlistStats
```

| Field | Value    |
| ----- | -------- |
| Auth  | Optional |

Get waitlist statistics. Works for both authenticated and unauthenticated users.