---
title: "Get the workspace's referral summary"
method: GET
path: "/referral/summary/"
tags: ["referral"]
---

# Get the workspace's referral summary

`GET /referral/summary/`

## Request

- Base URL: `https://api.getoneprofile.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.getoneprofile.ai/referral/summary/`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

The workspace's shareable referral link, the three headline counts, and the reward amounts the explainer copy quotes. The referral code is minted on first read, so a workspace that never opens the page never gets one.

## Response `200`

Successful Response

- ReferralSummaryReadSchema: Everything the referrals page needs before it lists anything.
  - `code` string, required: The workspace's permanent referral code.
  - `conversion_reward_credits` integer, required: Whole credits paid to BOTH sides when a referred workspace starts its first paid plan. Signing up pays nothing.
  - `link` string, required: The full URL to share. Assembled server-side so the client never has to know which domain the program currently points at.
  - `stats` ReferralStatsSchema, required: The three headline numbers on the referrals page.
    - `converted_count` integer, required: How many of them are on a paid plan.
    - `credits_earned` number, required: Credits this workspace has been paid by the referral program, in decimal credits. Summed from payouts actually granted, so it never disagrees with the balance.
    - `signed_up_count` integer, required: How many friends have joined through the link, in total. Cumulative: it includes the ones who have since started paying.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `422`: Invalid request made to the API.
- `500`: Internal server error.
- `502`: Bad gateway error.
- `503`: Service unavailable.

---

[API](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile.md) · [All operations](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/llms.txt) · [OpenAPI document](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/revisions/4a6bd71e3f02?raw)