> ## 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.

# Retrieve a business referral

> Retrieves a single referred business and its referral terms.



## OpenAPI

````yaml /openapi/api-v1-native.yml get /referrals/businesses/{id}
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/{id}:
    parameters:
      - $ref: '#/components/parameters/ApiVersionDate'
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: The business referral ID (a coma_ identifier).
    get:
      tags:
        - Referrals
      summary: Retrieve a business referral
      description: Retrieves a single referred business and its referral terms.
      operationId: retrieveBusinessReferral
      responses:
        '200':
          description: business referral retrieved
          content:
            application/json:
              schema:
                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.
                      capabilities:
                        $ref: '#/components/schemas/AccountCapabilities'
                        nullable: true
                      required_actions:
                        type:
                          - array
                          - 'null'
                        items:
                          $ref: '#/components/schemas/AccountRequiredAction'
                        description: >-
                          Actions the referred account owner must take to
                          unblock capabilities.
                      recommended_actions:
                        type:
                          - array
                          - 'null'
                        items:
                          $ref: '#/components/schemas/AccountRecommendedAction'
                        description: >-
                          Optional actions that unlock capabilities or grow the
                          referred account.
                    required:
                      - id
                      - title
                      - logo_url
                      - route
                      - capabilities
                      - required_actions
                      - recommended_actions
                  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.
                  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
        '404':
          $ref: '#/components/responses/NotFound'
          description: no such business referral is visible to the credential
      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.
  schemas:
    AccountCapabilities:
      type: object
      properties:
        accept_card_payments:
          type: string
          description: Card payins, including Apple Pay and Google Pay
          enum:
            - active
            - inactive
            - pending
          example: active
        accept_bank_payments:
          type: string
          description: 'Bank payins: debits, transfers, and local bank rails'
          enum:
            - active
            - inactive
            - pending
          example: active
        accept_bnpl_payments:
          type: string
          description: Buy-now-pay-later payins; requires approval
          enum:
            - active
            - inactive
            - pending
          example: active
        standard_payout:
          type: string
          description: Standard payouts to an external payout destination
          enum:
            - active
            - inactive
            - pending
          example: active
        instant_payout:
          type: string
          description: Instant payouts to an eligible payout destination
          enum:
            - active
            - inactive
            - pending
          example: active
        crypto_payout:
          type: string
          description: On-chain payouts to a crypto wallet
          enum:
            - active
            - inactive
            - pending
          example: active
        transfer:
          type: string
          description: Transfers to other accounts
          enum:
            - active
            - inactive
            - pending
          example: active
        bank_deposit:
          type: string
          description: Deposits by bank wire or ACH to the account's virtual bank account
          enum:
            - active
            - inactive
            - pending
          example: active
        crypto_deposit:
          type: string
          description: On-chain deposits to the account's crypto wallet
          enum:
            - active
            - inactive
            - pending
          example: active
        card_deposit:
          type: string
          description: Balance top-ups by charging a stored payment method
          enum:
            - active
            - inactive
            - pending
          example: active
        card_issuing:
          type: string
          description: Issuing Whop cards; requires card application approval
          enum:
            - active
            - inactive
            - pending
          example: active
      required:
        - accept_card_payments
        - accept_bank_payments
        - accept_bnpl_payments
        - standard_payout
        - instant_payout
        - crypto_payout
        - transfer
        - bank_deposit
        - crypto_deposit
        - card_deposit
        - card_issuing
    AccountRequiredAction:
      type: object
      properties:
        action:
          type: string
          description: >-
            What the holder must do; new values may be added, so handle unknown
            actions gracefully
          enum:
            - deposit_funds
            - submit_information_request
            - verify_identity
            - connect_fulfillment_tracker
          example: deposit_funds
        status:
          type: string
          description: required (act now) or pending (under review)
          enum:
            - required
            - pending
          example: required
        title:
          type: string
          description: Headline for the action
        description:
          type: string
          description: Supporting copy, or empty
        cta_label:
          type: string
          description: Button label, or empty when there is no button
        cta:
          type:
            - string
            - 'null'
          description: The URL the call-to-action links to, or null when there is no button
        icon_url:
          type:
            - string
            - 'null'
          description: The URL of the action's illustration icon, or null if it has none
        blocked_capabilities:
          type: array
          items:
            type: string
            description: Capabilities gated until this is resolved
      required:
        - action
        - status
        - title
        - description
        - cta_label
        - cta
        - icon_url
        - blocked_capabilities
    AccountRecommendedAction:
      type: object
      properties:
        action:
          type: string
          description: >-
            The recommendation; new values may be added, so handle unknown
            actions gracefully
          enum:
            - apply_for_financing
            - migrate_from_stripe
            - accept_first_payment
            - join_whop_university
          example: apply_for_financing
        status:
          type: string
          description: Always optional — never blocking
          enum:
            - optional
          example: optional
        title:
          type: string
          description: Headline for the recommendation
        description:
          type: string
          description: Supporting copy, or empty
        cta_label:
          type: string
          description: Button label
        cta:
          type: string
          description: The URL the call-to-action links to
        icon_url:
          type:
            - string
            - 'null'
          description: Illustration icon URL, or `null`
        blocked_capabilities:
          type: array
          items:
            type: string
            description: Capabilities this would unlock, or empty
      required:
        - action
        - status
        - title
        - description
        - cta_label
        - cta
        - icon_url
        - blocked_capabilities
    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
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/V1ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: auth-scheme
      description: >-
        An account API key, account scoped JWT, app API key, or user OAuth
        token.

````