Skip to main content
GET
Get a referrer's referred clients with lifecycle segments

Authorizations

Authorization
string
header
required

Bearer token from Geomi. See Authentication for setup instructions.

Query Parameters

referrer_account
string
required

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

days
integer<int64>

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

Required range: x >= 0
limit
integer<int32>

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

Required range: x >= 0
offset
integer<int32>

Clients to skip. Clamped to 10000.

Required range: x >= 0
segment
string

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

Case-insensitive substring match on the client address.

Response

Segment counts and a page of clients

clients
object[]
required
referrer_account
string
required
segments
object
required

How many clients sit in each lifecycle bucket. Always the whole referral set, never the filtered page, so the four counts sum to the affiliate's referral total.

total_count
integer<int64>
required

Clients matching the current filter, for pagination

Required range: x >= 0