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
import requests

url = "https://loyalty-admin.appstle.com/loyalty/cp/api/customer-referrals"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://loyalty-admin.appstle.com/loyalty/cp/api/customer-referrals', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
const url = 'https://loyalty-admin.appstle.com/loyalty/cp/api/customer-referrals';
const options = {method: 'GET'};

fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://loyalty-admin.appstle.com/loyalty/cp/api/customer-referrals",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://loyalty-admin.appstle.com/loyalty/cp/api/customer-referrals"

req, _ := http.NewRequest("GET", url, nil)

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
require 'uri'
require 'net/http'

url = URI("https://loyalty-admin.appstle.com/loyalty/cp/api/customer-referrals")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
[
  {
    "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"
  }
]

Query Parameters

pageable
object
required

Pagination parameters (page number, size, sort)

Response

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

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