---
title: "Get the affiliate dashboard summary"
method: GET
path: "/affiliate/summary/"
tags: ["affiliate"]
---

# Get the affiliate dashboard summary

`GET /affiliate/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/affiliate/summary/`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

Standing, codes, the shareable link, the headline stats and the program terms: everything the dashboard's overview needs in one read.

## Response `200`

Successful Response

- AffiliateSummaryReadSchema: Everything the affiliate dashboard's overview needs in one read.
  - `code` string, required: The minted default code.
  - `display_name` string, required
  - `link` string, required: The full URL to share, using the vanity code when claimed.
  - `profile` AffiliateProfileReadSchema, required: The caller's own standing in the affiliate program.
    - `contact_email` string, required
    - `created_at` string, date-time, required
    - `display_name` string, required
    - `id` string, uuid, required
    - `identity_verified_at` string, date-time, nullable, required
    - `paypal_email` string, nullable, required
    - `paypal_email_confirmed_at` string, date-time, nullable, required
    - `status` 'active' | 'suspended' | 'banned', required: Whether an affiliate may earn and be paid.
  - `program` AffiliateProgramReadSchema, required: What the affiliate program pays right now: the public half of the offer.
    - `conversion_deadline_days` integer, required: Days after signup within which a referral must start paying for the stamped terms to hold; later conversions earn the standard schedule.
    - `duration_months` integer, required: How many months of that customer's payments the rate applies to.
    - `launch_offer_active` boolean, required: Whether the launch offer currently applies.
    - `launch_offer_ends_on` string, date, required: The last day of the launch offer, unless ended earlier.
    - `payout_minimum_cents` integer, required: Available balance, in USD cents, below which a monthly payout rolls over.
    - `pending_days` integer, required: How long an earned commission stays pending before it is payable.
    - `rate_bps` integer, required: Commission rate a customer attributed today is stamped with, in basis points.
    - `standard_duration_months` integer, required: The standard duration, in months, outside the launch offer.
    - `standard_rate_bps` integer, required: The standard rate, in basis points, outside the launch offer.
  - `stats` AffiliateStatsReadSchema, required: The affiliate dashboard's headline numbers.
    - `available_cents` integer, required: Payable balance; negative when clawbacks exceed earnings.
    - `click_count` integer, required: Deduplicated, bot-filtered clicks on the affiliate's links.
    - `lifetime_earned_cents` integer, required: All commission ever accrued.
    - `lifetime_paid_cents` integer, required: All payouts ever sent.
    - `paying_count` integer, required: Of those, how many are on a paid plan.
    - `pending_cents` integer, required: Commission still inside the pending window.
    - `registered_count` integer, required: Workspaces that signed up through the links.
  - `status` 'active' | 'suspended' | 'banned', required: Whether an affiliate may earn and be paid.
  - `vanity_code` string, nullable, required: The claimed custom code, when one exists.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not enrolled.
- `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)