Referrals

Referral system management

Generate referral invitation

post
/rest_api/v2/referrals/invitations

Create a new referral invitation link for a customer

Body
emailstring · emailRequired
Responses
post
/rest_api/v2/referrals/invitations
200

Invitation generated successfully

Get customer referrers

get
/rest_api/v2/referrals/customers/{customerId}/referrers

Retrieve list of customers who referred this customer

Path parameters
customerIdstringRequired

Customer ID

Responses
get
/rest_api/v2/referrals/customers/{customerId}/referrers
200

List of referrers

Get customer referral summary

get
/rest_api/v2/referrals/customers/{customerId}/summary

Retrieve comprehensive referral statistics for a customer

Path parameters
customerIdstringRequired

Customer ID

Responses
get
/rest_api/v2/referrals/customers/{customerId}/summary
200

Referral summary

Get referral analytics

get
/rest_api/v2/referrals/analytics

Retrieve referral program analytics and performance metrics

Query parameters
startDatestring · dateOptional
endDatestring · dateOptional
Responses
get
/rest_api/v2/referrals/analytics
200

Referral analytics data