Skip to main content
GET
List sub-affiliates
The partners enrolled beneath you, and the second-tier override you have earned through each of them. Required scope: affiliates:read.
Most workspaces get {"data": []} here. Sub-affiliates are part of a partner arrangement, not a self-serve feature — see Who appears here.

Scoping

Like GET /affiliates/stats, this endpoint always reports on the workspace that issued the API key. There is no company id parameter anywhere in the request, and supplying company_id returns 400. There are no query parameters and no request body.

Who appears here

A row exists only for a partner Yappr has explicitly enrolled beneath you. Two consequences worth being clear about:
  • A customer who happens to share their own referral link does not become your sub-affiliate, does not appear in this list, and their customers’ revenue is never disclosed to you.
  • A partner enrolled yesterday who has referred nobody yet does appear — as a row of zeros. The list is built from the referral graph, not from revenue, so “enrolled, nothing yet” is a visible state rather than an absent one. Do not treat a zero row as a bug or filter it out.
Enrolment is also what starts the clock: you earn an override on a sub-affiliate’s customers from the moment the referral is made, never retroactively on revenue those customers generated beforehand.

Response fields

Every row is one enrolled sub-affiliate. All amounts are integer US cents — divide by 100 for dollars. Your override does not come out of your sub-affiliate’s commission. They earn their own full rate on their own customers; yours is paid on top by Yappr. my_override_cents and my_override_payable_cents differ for exactly the reason described under “Earned vs payable” on Affiliate stats — recent revenue is still inside the hold window and is not yet claimable. Summing my_override_cents across every row reconciles to summary.override_earned_cents on GET /affiliates/stats, and summing my_direct_cents gives the part of summary.direct_earned_cents that came from your sub-affiliates’ own spend rather than from your ordinary customers.

Example request

Example response

The second row is a partner enrolled recently who has not referred anyone yet. That is the expected shape, not an empty result.

Errors

Authorizations

Authorization
string
header
required

Your Yappr API key (e.g. ypr_live_...). Generate one in the dashboard under Settings → API Keys.

Response

Sub-affiliates

data
object[]