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

# List affiliates

`GET /affiliates`

Returns a paginated list of affiliates for the actor in context, with optional filtering by status, search, and sorting.

Required permissions:
 - `affiliate:basic:read`

## Query parameters

- `after` string, nullable — Returns the elements in the list that come after the specified cursor.
- `before` string, nullable — Returns the elements in the list that come before the specified cursor.
- `first` integer, nullable — Returns the first _n_ elements from the list.
- `last` integer, nullable — Returns the last _n_ elements from the list.
- `company_id` string, required — The unique identifier of the company to list affiliates for.
- `direction` 'asc' | 'desc' — The direction of the sort.
- `order` 'id' | 'created_at' | 'cached_total_referrals' | 'cached_total_rewards' — Which columns can be used to sort.
- `query` string, nullable — Search affiliates by username.
- `status` 'active' | 'archived' | 'deleted' — Statuses for resources

## Response `200`

A successful response

- object — The connection type for Affiliate.
  - `data` AffiliateListItem[], required — A list of nodes.
    - `active_members_count` integer, required — The total active members of the affiliate
    - `company` object, required — The company attached to this affiliate
      - `id` string, required — The unique identifier for the company.
      - `title` string, required — The written name of the company.
    - `created_at` string, date-time, required — The datetime the affiliate was created.
    - `customer_retention_rate` string, required — The percentage of referred customers who are still active members
    - `customer_retention_rate_ninety_days` string, required — The percentage of referred customers who remained active over the last 90 days
    - `id` string, required — The unique identifier for the affiliate.
    - `monthly_recurring_revenue_usd` string, required — The monthly recurring revenue generated by this affiliate's referrals, formatted as a USD currency string
    - `status` 'active' | 'archived' | 'deleted', required — Statuses for resources
    - `total_overrides_count` integer, required — The total count of all overrides for this affiliate
    - `total_referral_earnings_usd` string, required — The total commission earnings paid to this affiliate, formatted as a USD currency string
    - `total_referrals_count` integer, required — The total referrals of the affiliate
    - `total_revenue_usd` string, required — The total revenue generated from this affiliate's referrals, formatted as a USD currency string
    - `updated_at` string, date-time, required — The datetime the affiliate was last updated.
    - `user` object, required — The user attached to this affiliate
      - `id` string, required — The unique identifier for the user.
      - `name` string, nullable, required — The display name set on the user's Whop profile. Null if the user has not set a name.
      - `username` string, nullable, required — The unique username chosen by the user for their Whop profile. Null if the user has not set a username.
  - `page_info` PageInfo, required — Information about pagination in a connection.
    - `end_cursor` string, nullable, required — When paginating forwards, the cursor to continue.
    - `has_next_page` boolean, required — When paginating forwards, are there more items?
    - `has_previous_page` boolean, required — When paginating backwards, are there more items?
    - `start_cursor` string, nullable, required — When paginating backwards, the cursor to continue.

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `422` — Verification required
- `429` — Too many requests
- `500` — Internal server error

---

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