---
title: "Referral-ladder progress for a code (count only, never emails)."
method: GET
path: "/v1/referral"
---

# Referral-ladder progress for a code (count only, never emails).

`GET /v1/referral`

## Request

- Base URL: `https://api.buildervet.au`
- URL: `https://api.buildervet.au/v1/referral`
- Auth: none declared

## Query parameters

- `code` string, required

## Response `200`

OK

- ReferralStatus
  - `ok` boolean
  - `refCode` string: This email's shareable referral code.
  - `referrals` integer: Distinct emails referred by this code.

## Other responses

- `400`: Invalid code

---

[API](https://skmtc.dev/buildervet/apis/buildervet-api.md) · [All operations](https://skmtc.dev/buildervet/apis/buildervet-api/llms.txt) · [OpenAPI document](https://skmtc.dev/buildervet/apis/buildervet-api/revisions/8ac7930a2aad?raw)