Skip to main content
GET
/
loyalty
/
cp
/
api
/
customer-referrals
Get customer referral history
curl --request GET \
  --url https://loyalty-admin.appstle.com/loyalty/cp/api/customer-referrals
[
  {
    "id": 12345,
    "shop": "example-store.myshopify.com",
    "customerId": 67890,
    "referredEmailId": "friend@example.com",
    "description": "Referred friend via email",
    "referralRuleId": 1,
    "status": "PENDING",
    "createAt": "2025-01-15T10:30:00Z"
  }
]

Documentation Index

Fetch the complete documentation index at: https://appstleinc-aeca3e0a.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Query Parameters

​
pageable
object
required

Pagination parameters (page number, size, sort)

Response

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

​
shop
string
required
​
customerId
integer<int64>
required
​
referredEmailId
string
required
​
status
enum<string>
required
Available options:
PENDING,
CLAIMED,
RECURRING
​
createAt
string<date-time>
required
​
id
integer<int64>
​
description
string
​
referralRuleId
integer<int64>
​
claimAt
string<date-time>
​
referralRewarded
boolean
​
referredRewarded
boolean
​
referralNote
string
​
referredNote
string
​
pixelData
string