> ## 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 business referrals > Lists the businesses the authenticated user referred onto Whop, most recent first. ## OpenAPI ````yaml /openapi/api-v1-native.yml get /referrals/businesses openapi: 3.1.0 info: title: Whop API description: >- Hand-written V1 endpoints. Merged into the GraphqlRestProxy-generated schema at build time. version: v1 servers: - url: https://{defaultHost} variables: defaultHost: default: api.whop.com/api/v1 security: [] paths: /referrals/businesses: parameters: - $ref: '#/components/parameters/ApiVersionDate' get: tags: - Referrals summary: List business referrals description: >- Lists the businesses the authenticated user referred onto Whop, most recent first. operationId: listBusinessReferrals parameters: - name: status in: query required: false schema: type: string enum: - active - removed description: Filter by referral status. - name: has_earnings in: query required: false schema: type: boolean description: >- When true, only businesses with pending or completed earnings paid to the caller. - name: first in: query required: false schema: type: integer default: 20 maximum: 100 description: Number of business referrals to return from the start of the window. - name: after in: query required: false schema: type: string description: Cursor to fetch the page after (from page_info.end_cursor). - name: last in: query required: false schema: type: integer maximum: 100 description: Number of business referrals to return from the end of the window. - name: before in: query required: false schema: type: string description: Cursor to fetch the page before (from page_info.start_cursor). - name: order in: query required: false schema: type: string enum: - created_at - referral_started_at - referral_expires_at - payout_percentage - volume_usd - earnings_usd default: created_at description: The field to sort business referrals by. - name: direction in: query schema: type: string enum: - asc - desc default: desc required: false description: Sort direction. - name: active_before in: query required: false schema: type: string description: >- Only return business referrals with a transaction before this timestamp. - name: active_after in: query required: false schema: type: string description: >- Only return business referrals with a transaction after this timestamp. responses: '200': description: business referrals listed content: application/json: schema: type: object properties: data: type: array items: type: object properties: object: type: string enum: - business_referral id: type: string description: Business referral ID. account: type: - object - 'null' description: Referred account. properties: id: type: string description: Referred account ID. title: type: string description: Referred account display name. logo_url: type: - string - 'null' description: Referred account logo URL. route: type: string description: Referred account route. required: - id - title - logo_url - route user: type: - object - 'null' description: Owner of the referred account. properties: id: type: string description: User ID, prefixed `user_`. username: type: string description: The user's unique username. name: type: - string - 'null' description: The user's display name. profile_picture: type: object properties: url: type: string description: The user's profile picture URL. required: - url description: The user's profile picture. required: - id - username - name - profile_picture status: type: string enum: - active - removed description: Current referral status. example: active payout_percentage: type: number format: float description: >- Referrer's share of Whop gross profit, as a fraction (0.3 = 30%). referral_started_at: type: - string - 'null' format: date-time description: When the referral became active. referral_expires_at: type: - string - 'null' format: date-time description: When the referral expires. created_at: type: string format: date-time description: When the business referral was created. volume_usd: type: object properties: attributed: type: string description: >- Credited GMV (awaiting_settlement + settled); excludes canceled and reversed, in USD. awaiting_settlement: type: string description: >- GMV awaiting settlement (commission not yet computed), in USD. settled: type: string description: GMV of pending + completed payments, in USD. required: - attributed - awaiting_settlement - settled earnings_usd: type: object properties: total: type: string description: Pending + completed commission, in USD. pending: type: string description: Commission scheduled but not yet paid, in USD. completed: type: string description: Commission already paid out, in USD. required: - total - pending - completed required: - object - id - account - user - status - payout_percentage - referral_started_at - referral_expires_at - created_at - volume_usd - earnings_usd page_info: type: object properties: has_next_page: type: boolean end_cursor: type: - string - 'null' has_previous_page: type: boolean start_cursor: type: - string - 'null' required: - has_next_page - end_cursor - has_previous_page - start_cursor required: - data - page_info '400': $ref: '#/components/responses/InvalidParameters' description: invalid sort field '401': $ref: '#/components/responses/Unauthorized' description: missing or invalid authentication '403': $ref: '#/components/responses/Forbidden' description: credential lacks the referral-read scope security: - bearerAuth: - referral:basic:read components: parameters: ApiVersionDate: name: Api-Version-Date in: header required: false schema: type: string format: date example: '2026-07-01' description: Pins the request to a dated API version. responses: InvalidParameters: description: Invalid Parameters content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' Unauthorized: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' Forbidden: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' schemas: V1ErrorResponse: type: object properties: error: type: object properties: type: type: string description: Machine-readable error code. message: type: string description: Human-readable error message. required: - type - message required: - error securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: auth-scheme description: >- An account API key, account scoped JWT, app API key, or user OAuth token. ````