---
title: "Get affiliate(s)"
method: GET
path: "/affiliates"
---

# Get affiliate(s)

`GET /affiliates`

Returns a single affiliate when `id` or `email` is supplied, or every affiliate in the program when neither is. Looking up an affiliate that does not exist returns `null` with a 200, not a 404.

Each affiliate includes an `affiliateLinks` array holding every referral link slug they own — this is the source of truth for links. The legacy `link` field is deprecated and is usually `null`; use the [affiliate link endpoints](/api-reference/links/get) to manage links.

## Query parameters

- `id` string
- `email` string, email

## Response `200`

A single affiliate when filtering by `id` or `email` (`null` if no match), otherwise every affiliate in the program.

- union
  - Affiliate
    - `id` string, uuid — The affiliate ID
    - `firstName` string — First name of the affiliate
    - `lastName` string — Last name of the affiliate
    - `name` string, nullable — Full name of the affiliate (optional)
    - `email` string, email — Email of the affiliate
    - `password` string, nullable — Hashed Password of the affiliate (optional)
    - `emailVerified` boolean, nullable — Flag to indicate if the email has been verified
    - `image` string, nullable — Profile image URL of the affiliate
    - `detailsComplete` boolean — Flag to indicate if affiliate details are complete
    - `programId` string, uuid — The program ID that the affiliate is associated with
    - `payoutEmail` string, email — Email to be used for payouts
    - `paymentMethod` string — Payment method for the affiliate (e.g., WISE)
    - `commissionRate` number, float — Commission rate for the affiliate (0 - 100)
    - `link` string, nullable — Deprecated legacy field and almost always `null`. Read `affiliateLinks` instead.
    - `affiliateLinks` AffiliateLinkRecord[] — All affiliate link records for this affiliate. This is the source of truth for referral link slugs.
      - `id` string, uuid — Affiliate link record ID
      - `link` string — Link slug (path segment) for this affiliate
      - `userId` string, uuid, nullable — Affiliate user ID
      - `programId` string, uuid, nullable — Affiliate program ID
      - `createdAt` string, date-time — When this link was created
      - `updatedAt` string, date-time — When this link was last updated
    - `status` 'ACTIVE' | 'INACTIVE' | 'INVITED' | 'DECLINED' | 'DEACTIVATED' | 'BANNED' — Affiliate status. `INACTIVE` is shown as **Pending** in the dashboard and is kept for backwards compatibility.
    - `createdAt` string, date-time — Timestamp when the affiliate was created
    - `updatedAt` string, date-time — Timestamp when the affiliate was last updated
    - `numberOfReferredUsers` integer — Number of users referred by the affiliate
    - `numberOfClicks` integer — Number of clicks generated by the affiliate
    - `totalCommissionEarned` number, float — Total commission earned by the affiliate
    - `source` string, nullable — How the affiliate joined. Affiliates created through this API have `API`.
    - `commissionPlanId` string, uuid, nullable — The commission plan assigned to this affiliate, if any
    - `affiliateGroupId` string, uuid, nullable — The affiliate group this affiliate belongs to, if any
  - Affiliate[]
    - `id` string, uuid — The affiliate ID
    - `firstName` string — First name of the affiliate
    - `lastName` string — Last name of the affiliate
    - `name` string, nullable — Full name of the affiliate (optional)
    - `email` string, email — Email of the affiliate
    - `password` string, nullable — Hashed Password of the affiliate (optional)
    - `emailVerified` boolean, nullable — Flag to indicate if the email has been verified
    - `image` string, nullable — Profile image URL of the affiliate
    - `detailsComplete` boolean — Flag to indicate if affiliate details are complete
    - `programId` string, uuid — The program ID that the affiliate is associated with
    - `payoutEmail` string, email — Email to be used for payouts
    - `paymentMethod` string — Payment method for the affiliate (e.g., WISE)
    - `commissionRate` number, float — Commission rate for the affiliate (0 - 100)
    - `link` string, nullable — Deprecated legacy field and almost always `null`. Read `affiliateLinks` instead.
    - `affiliateLinks` AffiliateLinkRecord[] — All affiliate link records for this affiliate. This is the source of truth for referral link slugs.
      - `id` string, uuid — Affiliate link record ID
      - `link` string — Link slug (path segment) for this affiliate
      - `userId` string, uuid, nullable — Affiliate user ID
      - `programId` string, uuid, nullable — Affiliate program ID
      - `createdAt` string, date-time — When this link was created
      - `updatedAt` string, date-time — When this link was last updated
    - `status` 'ACTIVE' | 'INACTIVE' | 'INVITED' | 'DECLINED' | 'DEACTIVATED' | 'BANNED' — Affiliate status. `INACTIVE` is shown as **Pending** in the dashboard and is kept for backwards compatibility.
    - `createdAt` string, date-time — Timestamp when the affiliate was created
    - `updatedAt` string, date-time — Timestamp when the affiliate was last updated
    - `numberOfReferredUsers` integer — Number of users referred by the affiliate
    - `numberOfClicks` integer — Number of clicks generated by the affiliate
    - `totalCommissionEarned` number, float — Total commission earned by the affiliate
    - `source` string, nullable — How the affiliate joined. Affiliates created through this API have `API`.
    - `commissionPlanId` string, uuid, nullable — The commission plan assigned to this affiliate, if any
    - `affiliateGroupId` string, uuid, nullable — The affiliate group this affiliate belongs to, if any

## Other responses

- `401` — The `Authorization` header is missing, is not a `Bearer` header, or the token is not valid.
- `403` — API access is not enabled for this account.
- `404` — The affiliate program this token belongs to no longer exists.
- `429` — Too many requests for this token on this endpoint. Please slow down.

---

[API](https://skmtc.net/referly/apis/referly-api.md) · [All operations](https://skmtc.net/referly/apis/referly-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/referly/referly-api/versions/0f506d61b9c3/schema)