Skip to main content
GET
Get a customer's referral history

Headers

X-API-Key
string
required

API key for authentication

Query Parameters

customerId
integer<int64>
required

Shopify customer ID of the referring customer

pageable
object
required

Pagination parameters (page number, size, sort)

Response

Successfully retrieved the customer's referrals

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>
orderCount
integer<int32>
pixelData
string
referralNote
string
referralRewarded
boolean
referralRuleId
integer<int64>
referredNote
string
referredRewarded
boolean