APappstle
Referrals

Get customer referral history

Changed on

Retrieves paginated list of referrals made by the authenticated customer. Each entry includes a masked recipient email, referral status, reward progress, and timestamps. Recipient tracking data and internal notes are excluded.

get/loyalty/cp/api/customer-referrals

Request

  • Base URL
    https://your-store.myshopify.com/apps
  • URL
    https://your-store.myshopify.com/apps/loyalty/cp/api/customer-referrals
  • Auth
    none declared

Query parameters

pageinteger
sizeinteger
sortstring[]

Pagination parameters (page number, size, sort)

Response

Customer referrals retrieved successfully with pagination headers (X-Total-Count, Link)

claimAtstring date-time
createAtstring date-time required
customerIdinteger required
descriptionstring
idinteger
orderCountinteger
pixelDatastring
referralNotestring
referralRewardedboolean
referralRuleIdinteger
referredEmailIdstring required
referredNotestring
referredRewardedboolean
shopstring required
status'PENDING' | 'CLAIMED' | 'RECURRING' required

Changes

  • f9124ac8febfRevision changes
    • breaking

      the response's body type changed from object to array for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

  • 8edeacd77e98Revision changes
    • info

      added the optional property to the response with the status