DEdecibel
Referrals

Get a referrer's referred clients with lifecycle segments

Changed on

Segment counts across the whole referral set, plus a filtered page of clients ordered by window volume. Carries no commission amounts: the accrual ledger is not built yet.

get/api/v1/referrals/clients

Request

Query parameters

referrer_accountstring required

The referrer's wallet address (not a subaccount address)

daysinteger

Trailing UTC days the volume columns cover. Defaults to 30, clamped to 90.

limitinteger

Clients per page. Defaults to 25, clamped to 200.

offsetinteger

Clients to skip. Clamped to 10000.

segmentstring

Keep only one lifecycle bucket: active, at_risk, dormant or never_traded.

searchstring

Case-insensitive substring match on the client's owner address or any of its subaccounts.

include_identitiesboolean

Look up each client's wallet address. Defaults to true; pass false to skip the scan when the caller does not render it.

Response

Segment counts and a page of clients

referrer_accountstring required
total_countinteger required

Clients matching the current filter, for pagination

Changes