---
title: "Affiliate Portal"
method: GET
path: "/api/v1/affiliate/portal/{token}"
tags: ["affiliate"]
---

# Affiliate Portal

`GET /api/v1/affiliate/portal/{token}`

## Request

- Base URL: `https://api.nudgelink.co` (the document declares no server; this is the origin it was published from)
- URL: `https://api.nudgelink.co/api/v1/affiliate/portal/{token}`
- Auth: none declared

## Path parameters

- `token` string, required

## Response `200`

Successful Response

- PortalResponse
  - `name` string, required
  - `commission_rate_percent` number, required
  - `commission_duration_months` integer, required
  - `active` boolean, required
  - `stats` PortalStats, required
    - `signups` integer, required
    - `active_subscriptions` integer, required
    - `mrr_usd` number, required
    - `commission_pending_usd` number, required
    - `commission_paid_usd` number, required
    - `commission_total_usd` number, required
  - `referrals` PortalReferral[], required
    - `signed_up_at` string, date-time, required
    - `stage` string, required
    - `is_paying` boolean, required
    - `commission_earned_usd` number, required
  - `commissions` PortalCommission[], required
    - `created_at` string, date-time, required
    - `amount_usd` number, required
    - `status` string, required
  - `payouts` PortalPayout[], required
    - `paid_at` string, date-time, required
    - `total_amount_usd` number, required
    - `commission_count` integer, required

## Other responses

- `422`: Validation Error

---

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