---
title: "Referral code, signups, earned and pending commission"
method: GET
path: "/v1/affiliate"
tags: ["affiliate"]
---

# Referral code, signups, earned and pending commission

`GET /v1/affiliate`

## Request

- Base URL: `https://api.portproof.org`
- URL: `https://api.portproof.org/v1/affiliate`
- Auth: one of:
  - API key in cookie `pp_session`
  - HTTP bearer

## Response `200`

Default Response

- object
  - `code` string, required
  - `url` string, uri, required
  - `clicks` integer, required
  - `signups` integer, required
  - `earned_cents` integer, required
  - `pending_cents` integer, required
  - `terms` object, required
    - `first_order_pct` number, required
    - `recurring_pct` number, required
    - `recurring_months` integer, required
    - `cap_cents_per_referred` integer, required
    - `payout_min_cents` integer, required
  - `events` object[], required
    - `id` string, required
    - `order_id` string, required
    - `referred` string, required
    - `commission_cents` integer, required
    - `kind` 'first' | 'recurring', required
    - `credited_at` string, date-time, nullable, required
    - `created_at` string, date-time, required

## Other responses

- `401`: Default Response

---

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