Skip to main content
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
FieldValue
AuthRequired
Get referral data for a specific entity.

​
Get Organization Referrals

GET /v1/organization/:entity/referral
FieldValue
AuthRequired
Get EquaCash balance and referral summary for an organization member.

​
Submit Company Info

POST /v1/referral/company
FieldValue
AuthRequired
Submit company information for a referral.

​
Invitations

​
Get Invitations

GET /v1/invitation
FieldValue
AuthRequired
List all invitations sent by the authenticated user.

​
Send Invitation Email

POST /v1/invitation/send
FieldValue
AuthRequired
Send a referral invitation email. Request: 
{
  "email": "friend@example.com",
  "message": "Check out Equa for cap table management!"
}

​
Rewards

​
Get Rewards

GET /v1/card
FieldValue
AuthRequired
List all reward cards for the authenticated user.

​
Reveal Reward Card

POST /v1/reward
FieldValue
AuthRequired
Reveal (scratch) a reward card to see its value. Request: 
{
  "rewardId": "uuid"
}

​
EquaCash

​
Transfer EquaCash

POST /v1/equaCash/transfer
FieldValue
AuthRequired
Transfer EquaCash between entities. Request: 
{
  "fromEntity": "uuid",
  "toEntity": "uuid",
  "amount": 50
}

​
Get Transfer History

GET /v1/entity/:entity/history
FieldValue
AuthRequired
Get EquaCash transfer history for an entity.

​
Google Contacts

​
Get Google Contacts

GET /v1/google
FieldValue
AuthRequired
Retrieve Google contacts for the invitation flow.

​
Waitlist Stats

​
Get Waitlist Stats

GET /v1/waitlistStats
FieldValue
AuthOptional
Get waitlist statistics. Works for both authenticated and unauthenticated users.