---
title: "Get Affiliate"
method: GET
path: "/api/v1/admin/affiliates/{affiliate_id}"
tags: ["admin"]
---

# Get Affiliate

`GET /api/v1/admin/affiliates/{affiliate_id}`

## 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/{affiliate_id}`
- Auth: HTTP bearer

## Path parameters

- `affiliate_id` string, uuid, required

## Response `200`

Successful Response

- AffiliateDetail
  - `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
  - `referred_users` ReferredUser[], required
    - `client_id` string, uuid, required
    - `email` string, required
    - `company` string, nullable, required
    - `signed_up_at` string, date-time, required
    - `first_paid_at` string, date-time, nullable, required
    - `stage` string, required
    - `subscription_plan` string, nullable, required
    - `is_paying` boolean, required
    - `mrr_usd` number, required
    - `commission_pending_usd` number, required
    - `commission_paid_usd` number, required
  - `commissions` CommissionRow[], required
    - `id` string, uuid, required
    - `client_id` string, uuid, required
    - `client_email` string, nullable, required
    - `amount_usd` number, required
    - `base_amount_usd` number, required
    - `rate_percent` number, required
    - `status` string, required
    - `created_at` string, date-time, required
    - `period_start` string, date-time, nullable, required
    - `period_end` string, date-time, nullable, required
    - `stripe_invoice_id` string, nullable, required
    - `payout_id` string, uuid, nullable, required
  - `payouts` PayoutRow[], required
    - `id` string, uuid, required
    - `total_amount_usd` number, required
    - `commission_count` integer, required
    - `paid_at` string, date-time, required
    - `external_reference` string, nullable, required
    - `note` string, nullable, 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)