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

# Get customer referral history



## OpenAPI

````yaml /loyalty/storefront-api-swagger.json get /loyalty/cp/api/customer-referrals
openapi: 3.0.1
info:
  description: ''
  title: Storefront APIs
  version: 0.0.1
servers:
  - url: https://loyalty-admin.appstle.com
security: []
tags:
  - description: >-
      Storefront APIs for the signed-in customer to enroll, enable the loyalty
      program, view their loyalty profile, sync metafields, and update profile
      attributes.
    name: Customer Enrollment & Profile
  - description: >-
      Storefront APIs for the signed-in customer to view point transactions,
      claim social-media reward points, and record store visits.
    name: Points & Earn Rules
  - description: >-
      Storefront APIs for the signed-in customer to redeem loyalty points for
      rewards or discount codes.
    name: Redemptions & Discount Codes
  - description: >-
      Storefront APIs for managing the signed-in customer's referral activity:
      generating referral URLs, sending invites, viewing referral history, and
      accepting referral offers.
    name: Referrals
  - description: >-
      Storefront APIs for the signed-in customer to submit product reviews and
      retrieve existing reviews for a product.
    name: Reviews
  - description: >-
      Storefront APIs for retrieving product and collection data, proxied
      through the Shopify Storefront API for loyalty widgets.
    name: Product Catalog
paths:
  /loyalty/cp/api/customer-referrals:
    get:
      tags:
        - Referrals
      summary: Get customer referral history
      operationId: getAllCustomerReferrals
      parameters:
        - description: Pagination parameters (page number, size, sort)
          in: query
          name: pageable
          required: true
          schema:
            $ref: '#/components/schemas/Pageable'
      responses:
        '200':
          content:
            application/json:
              example:
                - createAt: '2025-01-15T10:30:00Z'
                  customerId: 67890
                  description: Referred friend via email
                  id: 12345
                  referralRuleId: 1
                  referredEmailId: friend@example.com
                  shop: example-store.myshopify.com
                  status: PENDING
              schema:
                $ref: '#/components/schemas/CustomerReferral'
          description: >-
            Customer referrals retrieved successfully with pagination headers
            (X-Total-Count, Link)
        '401':
          description: Customer not authenticated
components:
  schemas:
    Pageable:
      properties:
        page:
          format: int32
          minimum: 0
          type: integer
        size:
          format: int32
          minimum: 1
          type: integer
        sort:
          items:
            type: string
          type: array
      type: object
    CustomerReferral:
      properties:
        claimAt:
          format: date-time
          type: string
        createAt:
          format: date-time
          type: string
        customerId:
          format: int64
          type: integer
        description:
          type: string
        id:
          format: int64
          type: integer
        pixelData:
          type: string
        referralNote:
          type: string
        referralRewarded:
          type: boolean
        referralRuleId:
          format: int64
          type: integer
        referredEmailId:
          type: string
        referredNote:
          type: string
        referredRewarded:
          type: boolean
        shop:
          type: string
        status:
          enum:
            - PENDING
            - CLAIMED
            - RECURRING
          type: string
      required:
        - createAt
        - customerId
        - referredEmailId
        - shop
        - status
      type: object

````