> ## Documentation Index > Fetch the complete documentation index at: https://docs.whop.com/llms.txt > Use this file to discover all available pages before exploring further. # List 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` ## OpenAPI ````yaml /openapi/api-v1-stable.json get /affiliates openapi: 3.1.0 info: description: >- The Whop REST API. Please see https://docs.whop.com/developer/api/getting-started for more details. termsOfService: https://whop.com/tos-developer-api/ title: Whop API version: 1.0.0 x-api-version-date: '2026-08-21' servers: - description: Production Whop API url: https://api.whop.com/api/v1 - description: Sandbox Whop API url: https://sandbox-api.whop.com/api/v1 security: [] tags: - description: Products name: Products - description: Payments name: Payments - description: Refunds name: Refunds - description: Disputes name: Disputes - description: Dispute alerts name: Dispute alerts - description: Resolution center cases name: Resolution center cases - description: Checkout configurations name: Checkout configurations - description: Setup intents name: Setup intents - description: Payment methods name: Payment methods - description: Invoices name: Invoices - description: Promo codes name: Promo codes - description: Card transactions name: Card transactions - description: Ledger accounts name: Ledger accounts - description: Withdrawals name: Withdrawals - description: Payout methods name: Payout methods - description: Verifications name: Verifications - description: Identity profiles name: Identity profiles - description: Payout accounts name: Payout accounts - description: Topups name: Topups - description: Companies name: Companies - description: Authorized users name: Authorized users - description: Fee markups name: Fee markups - description: Members name: Members - description: Memberships name: Memberships - description: Leads name: Leads - description: Entries name: Entries - description: Shipments name: Shipments - description: Reviews name: Reviews - description: Company token transactions name: Company token transactions - description: Affiliates name: Affiliates - description: Experiences name: Experiences - description: Forums name: Forums - description: Forum posts name: Forum posts - description: Chat channels name: Chat channels - description: Support channels name: Support channels - description: Messages name: Messages - description: Reactions name: Reactions - description: Dm members name: Dm members - description: Dm channels name: Dm channels - description: Notifications name: Notifications - description: Courses name: Courses - description: Course chapters name: Course chapters - description: Course lessons name: Course lessons - description: Course students name: Course students - description: Course lesson interactions name: Course lesson interactions - description: Apps name: Apps - description: Webhooks name: Webhooks - description: App builds name: App builds - description: Access tokens name: Access tokens - description: Account links name: Account links - description: Files name: Files - description: Ai chats name: Ai chats - description: Bounties name: Bounties - description: Stats name: Stats - description: Conversions name: Conversions - description: Ad reports name: Ad reports paths: /affiliates: get: tags: - Affiliates summary: List affiliates description: >- Returns a paginated list of affiliates for the actor in context, with optional filtering by status, search, and sorting. Required permissions: - `affiliate:basic:read` operationId: listAffiliate parameters: - explode: true in: query name: after required: false schema: description: >- Returns the elements in the list that come after the specified cursor. type: string style: form - explode: true in: query name: before required: false schema: description: >- Returns the elements in the list that come before the specified cursor. type: string style: form - explode: true in: query name: first required: false schema: description: Returns the first _n_ elements from the list. example: 42 type: integer style: form - explode: true in: query name: last required: false schema: description: Returns the last _n_ elements from the list. example: 42 type: integer style: form - explode: true in: query name: company_id required: true schema: description: The unique identifier of the company to list affiliates for. example: biz_xxxxxxxxxxxxxx type: string style: form - explode: true in: query name: direction required: false schema: $ref: '#/components/schemas/Direction' description: The sort direction for results. Defaults to descending. style: form - explode: true in: query name: order required: false schema: $ref: '#/components/schemas/AffiliatesSortableColumns' description: The field to sort results by. style: form - explode: true in: query name: query required: false schema: description: Search affiliates by username. type: string style: form - explode: true in: query name: status required: false schema: $ref: '#/components/schemas/Status' description: Filter by affiliate status (active or archived). style: form responses: '200': content: application/json: schema: description: The connection type for Affiliate. properties: data: description: A list of nodes. items: $ref: '#/components/schemas/AffiliateListItem' type: array page_info: $ref: '#/components/schemas/PageInfo' description: Information to aid in pagination. required: - data - page_info type: object description: A successful response '400': content: application/json: example: error: code: parameter_missing message: 'Missing required parameter: amount.' param: amount type: invalid_request_error schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Bad request '401': content: application/json: example: error: message: Invalid or missing API key type: unauthorized schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Unauthorized '403': content: application/json: example: error: message: You do not have permission to access this resource type: forbidden schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Forbidden '404': content: application/json: example: error: message: Resource not found type: not_found schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Not found '422': content: application/json: example: error: null schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Verification required '429': content: application/json: example: error: null schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Too many requests '500': content: application/json: example: error: message: An unexpected error occurred type: internal_server_error schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Internal server error security: - bearerAuth: - affiliate:basic:read x-codeSamples: - lang: JavaScript source: |- import Whop from '@whop/sdk'; const client = new Whop({ apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted }); // Automatically fetches more pages as needed. for await (const affiliateListResponse of client.affiliates.list({ company_id: 'biz_xxxxxxxxxxxxxx', })) { console.log(affiliateListResponse.id); } components: schemas: Direction: description: The direction of the sort. enum: - asc - desc type: string AffiliatesSortableColumns: description: Which columns can be used to sort. enum: - id - created_at - cached_total_referrals - cached_total_rewards type: string Status: description: Statuses for resources enum: - active - archived - deleted type: string AffiliateListItem: description: >- An affiliate tracks a user's referral performance and commission earnings for a company, including retention rates, revenue metrics, and payout configurations. properties: active_members_count: description: The total active members of the affiliate example: 42 type: integer company: description: The company attached to this affiliate properties: id: description: The unique identifier for the company. example: biz_xxxxxxxxxxxxxx type: string title: description: The written name of the company. type: string required: - id - title type: object created_at: description: The datetime the affiliate was created. example: '2023-12-01T05:00:00.401Z' format: date-time type: string customer_retention_rate: description: The percentage of referred customers who are still active members type: string customer_retention_rate_ninety_days: description: >- The percentage of referred customers who remained active over the last 90 days type: string id: description: The unique identifier for the affiliate. example: aff_xxxxxxxxxxxxxx type: string monthly_recurring_revenue_usd: description: >- The monthly recurring revenue generated by this affiliate's referrals, formatted as a USD currency string type: string status: description: The status of the affiliate oneOf: - $ref: '#/components/schemas/Status' - type: 'null' total_overrides_count: description: The total count of all overrides for this affiliate example: 42 type: integer total_referral_earnings_usd: description: >- The total commission earnings paid to this affiliate, formatted as a USD currency string type: string total_referrals_count: description: The total referrals of the affiliate example: 42 type: integer total_revenue_usd: description: >- The total revenue generated from this affiliate's referrals, formatted as a USD currency string type: string updated_at: description: The datetime the affiliate was last updated. example: '2023-12-01T05:00:00.401Z' format: date-time type: string user: description: The user attached to this affiliate properties: id: description: The unique identifier for the user. example: user_xxxxxxxxxxxxx type: string name: description: >- The display name set on the user's Whop profile. Null if the user has not set a name. example: Jane Smith type: - string - 'null' username: description: >- The unique username chosen by the user for their Whop profile. Null if the user has not set a username. example: janesmith type: - string - 'null' required: - id - name - username type: object required: - id - status - created_at - updated_at - total_referrals_count - total_referral_earnings_usd - total_overrides_count - customer_retention_rate - customer_retention_rate_ninety_days - monthly_recurring_revenue_usd - total_revenue_usd - active_members_count - user - company type: object PageInfo: description: Information about pagination in a connection. properties: end_cursor: description: When paginating forwards, the cursor to continue. type: - string - 'null' has_next_page: description: When paginating forwards, are there more items? type: boolean has_previous_page: description: When paginating backwards, are there more items? type: boolean start_cursor: description: When paginating backwards, the cursor to continue. type: - string - 'null' required: - end_cursor - start_cursor - has_next_page - has_previous_page type: object securitySchemes: bearerAuth: bearerFormat: auth-scheme description: >- An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with `Bearer`, for example `Bearer ***************************`. scheme: bearer type: http ````