/

Browse the help center

List referral revenue and payouts

Returns a paginated list of referral billing records showing revenue earned and payout status for each referred client.

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/referral-program/list.do

Returns a paginated list of referral billing records showing revenue earned and payout status for each referred client. Results can be filtered by year, month, and payment status. Supports sorting by email, status, revenue, year, or month.

Query Params

activeOnly boolean

When true, return only active (non-deleted) records

true

dir string

Sort direction: ASC or DESC

ASC

labels array<integer>

Filter by label IDs

101,102

limit integer

Maximum number of records to return per page

50

multisort array<string>

Multi-column sort configuration as a JSON array of objects with 'property' and 'direction' fields

[{"property":"id","direction":"ASC"}]

name string

Filter by entity name

my-campaign

onlyData boolean

When true, return only data rows without metadata

false

onlyTotal boolean

When true, return only the total count without data rows

false

query string

Search query string to filter results by name or other searchable fields

test

role integer

Filter by user role ID

3

sort string

Field name to sort results by

id

start integer

Pagination offset (0-based index of the first record to return)

0

year array<integer>

Filter by year

2026

month array<integer>

Filter by month (1-12)

3

status array<string>

Filter by payment status

PAID

Responses

200

Referral billing records returned successfully

400

Bad request — invalid or missing parameters

401

Authentication error

403

Not enough permissions

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/referral-program/list.do?name=my-campaign&activeOnly=true&dir=ASC' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/referral-program/list.do?name=my-campaign&activeOnly=true&dir=ASC", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/referral-program/list.do?name=my-campaign&activeOnly=true&dir=ASC', {
  method: 'GET',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/referral-program/list.do?name=my-campaign&activeOnly=true&dir=ASC"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("GET"), "https://YOUR-NETWORK-DOMAIN/rest-api/referral-program/list.do?name=my-campaign&activeOnly=true&dir=ASC");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/referral-program/list.do?name=my-campaign&activeOnly=true&dir=ASC", nil)
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")

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

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/referral-program/list.do?name=my-campaign&activeOnly=true&dir=ASC");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY"]);

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/referral-program/list.do?name=my-campaign&activeOnly=true&dir=ASC")
request = Net::HTTP::Get.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body