---
title: "List Affiliates"
method: GET
path: "/api/v1/admin/affiliates"
tags: ["admin"]
---

# List Affiliates

`GET /api/v1/admin/affiliates`

## 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/admin/affiliates`
- Auth: HTTP bearer

## Query parameters

- `include_inactive` boolean

## Response `200`

Successful Response

- AffiliateRow[]
  - `id` string, uuid, required
  - `code` string, required
  - `name` string, required
  - `contact_email` string, nullable, required
  - `commission_rate_percent` number, required
  - `commission_duration_months` integer, required
  - `active` boolean, required
  - `note` string, nullable, required
  - `signup_url` string, required
  - `portal_url` string, required
  - `created_at` string, date-time, required
  - `stats` AffiliateStats, 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

## 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)