Referral Program API endpoints

Referral program management — referred clients, revenue tracking, and earnings. 3 endpoints, generated from the OpenAPI spec. Authentication, the response envelope, pagination and error codes are shared by all endpoints — see REST API overview. Parameters marked form go in an application/x-www-form-urlencoded request body.

GET /rest-api/referral-program/list-registered.do

Request examples

List registered referred clients.

Parameter	In	Type	Required	Description
activeOnly	query	boolean	no	When true, return only active (non-deleted) records
dir	query	string	no	Sort direction: ASC or DESC
labels	query	array<integer>	no	Filter by label IDs
limit	query	integer	no	Maximum number of records to return per page
multisort	query	array<object>	no	Multi-column sort configuration as a JSON array of objects with ‘property’ and ‘direction’ fields
name	query	string	no	Filter by entity name
onlyData	query	boolean	no	When true, return only data rows without metadata
onlyTotal	query	boolean	no	When true, return only the total count without data rows
query	query	string	no	Search query string to filter results by name or other searchable fields
role	query	integer	no	Filter by user role ID
sort	query	string	no	Field name to sort results by
start	query	integer	no	Pagination offset (0-based index of the first record to return)
year	query	array<integer>	no	Filter by registration year
month	query	array<integer>	no	Filter by registration month (1-12)
status	query	array<string>	no	Filter by referred client status Values: UNDER_REVIEW, APPROVED, ACTIVE, INACTIVE.

Responses: 200 — Referred clients list returned successfully. Errors follow the shared conventions.

GET /rest-api/referral-program/list.do

Request examples

List referral revenue and payouts.

Parameter	In	Type	Required	Description
activeOnly	query	boolean	no	When true, return only active (non-deleted) records
dir	query	string	no	Sort direction: ASC or DESC
labels	query	array<integer>	no	Filter by label IDs
limit	query	integer	no	Maximum number of records to return per page
multisort	query	array<object>	no	Multi-column sort configuration as a JSON array of objects with ‘property’ and ‘direction’ fields
name	query	string	no	Filter by entity name
onlyData	query	boolean	no	When true, return only data rows without metadata
onlyTotal	query	boolean	no	When true, return only the total count without data rows
query	query	string	no	Search query string to filter results by name or other searchable fields
role	query	integer	no	Filter by user role ID
sort	query	string	no	Field name to sort results by
start	query	integer	no	Pagination offset (0-based index of the first record to return)
year	query	array<integer>	no	Filter by year
month	query	array<integer>	no	Filter by month (1-12)
status	query	array<string>	no	Filter by payment status Values: UNCONFIRMED, CONFIRMED, PAID, DECLINED.

Responses: 200 — Referral billing records returned successfully. Errors follow the shared conventions.

GET /rest-api/referral-program/total-earnings.do

Request examples

Get referral earnings summary.

Parameter	In	Type	Required	Description
activeOnly	query	boolean	no	When true, return only active (non-deleted) records
dir	query	string	no	Sort direction: ASC or DESC
labels	query	array<integer>	no	Filter by label IDs
limit	query	integer	no	Maximum number of records to return per page
multisort	query	array<object>	no	Multi-column sort configuration as a JSON array of objects with ‘property’ and ‘direction’ fields
name	query	string	no	Filter by entity name
onlyData	query	boolean	no	When true, return only data rows without metadata
onlyTotal	query	boolean	no	When true, return only the total count without data rows
query	query	string	no	Search query string to filter results by name or other searchable fields
role	query	integer	no	Filter by user role ID
sort	query	string	no	Field name to sort results by
start	query	integer	no	Pagination offset (0-based index of the first record to return)
year	query	array<integer>	no	Filter by year
month	query	array<integer>	no	Filter by month (1-12)
status	query	array<string>	no	Filter by payment status Values: UNCONFIRMED, CONFIRMED, PAID, DECLINED.

Responses: 200 — Earnings summary returned successfully. Errors follow the shared conventions.

Related

• REST API overview — authentication and conventions
• API endpoint reference by tag