Referral Report

Updated 10 September 2026

GET `?action=get_referrals`

Store-wide referral reporting: totals, top referrers, and the per-service breakdown of credits earned and spent.

Response Fields

Field	Type	Description
`enabled`	boolean	Whether referrals are switched on
`totals`	object	earned, signup_granted, adjusted, spent, outstanding
`counts`	object	active_codes, customers_referred, accounts
`top_referrers`	array	Up to 20 — customer_id, email, name, customers_referred, points_earned
`per_service`	array	plugin_id, service_name, earned, spent

Example request

$ch = curl_init('PANELR_API_URL?action=get_referrals');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => ['X-Panelr-API-Key: YOUR_API_KEY'],
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

curl -X GET "PANELR_API_URL?action=get_referrals" \
  -H "X-Panelr-API-Key: YOUR_API_KEY"

const res = await fetch('PANELR_API_URL?action=get_referrals', {
  headers: { 'X-Panelr-API-Key': 'YOUR_API_KEY' },
});
const { data } = await res.json();

import requests
r = requests.get('PANELR_API_URL',
    params={"action":"get_referrals"},
    headers={'X-Panelr-API-Key': 'YOUR_API_KEY'})
data = r.json()['data']

GET ?action=get_referrals

Response Fields

GET `?action=get_referrals`