> ## Documentation Index
> Fetch the complete documentation index at: https://docs.paygood.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List merchant referrals



## OpenAPI

````yaml /openapi.json get /merchants/{merchantId}/referrals
openapi: 3.0.0
info:
  title: PayGood Merchant API
  description: Server-to-server integration surface for merchant API keys.
  version: '1.0'
  contact: {}
servers:
  - url: https://api-sandbox.paygood.co
    description: Sandbox
  - url: https://api.paygood.co
    description: Production
security: []
paths:
  /merchants/{merchantId}/referrals:
    get:
      tags:
        - merchant-referrals
      summary: List merchant referrals
      operationId: MerchantReferralsController_list
      parameters:
        - name: cursor
          required: false
          in: query
          description: Opaque pagination cursor from a previous response.
          schema:
            type: string
        - name: limit
          required: false
          in: query
          description: Maximum referrals to return (default 20, max 100).
          schema:
            example: 20
            type: number
        - name: status
          required: false
          in: query
          description: Optional referral status filter.
          schema:
            type: string
            enum:
              - pending
              - completed
        - name: merchantId
          required: true
          in: path
          description: Referring merchant TypeID (`mer_...`).
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListMerchantReferralsResponseDto'
      security:
        - bearer: []
components:
  schemas:
    ListMerchantReferralsResponseDto:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              referralId:
                type: string
              referrerMerchantId:
                type: string
              referralCode:
                type: string
              refereeEmail:
                type: string
                format: email
                pattern: >-
                  ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
              refereeMemberId:
                type: string
                nullable: true
              refereeApplicationId:
                type: string
                nullable: true
              refereeMerchantId:
                type: string
                nullable: true
              status:
                type: string
                enum:
                  - pending
                  - completed
              completedAt:
                type: string
                nullable: true
              createdAt:
                type: string
            required:
              - referralId
              - referrerMerchantId
              - referralCode
              - refereeEmail
              - refereeMemberId
              - refereeApplicationId
              - refereeMerchantId
              - status
              - completedAt
              - createdAt
        nextCursor:
          type: string
          nullable: true
      required:
        - items
        - nextCursor
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: merchant_<prefix>_<secret>
      type: http
      description: >-
        Merchant API key bearer token. Legacy wire prefixes `api_key_` and
        `api_` are also accepted.

````