affiliate

GET `/v1/affiliate/referrals`

The customers who signed up through your links.

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.

A szervezet azonosítójának helye

Ez a végpont a(z) org_id paramétert lekérdezési paraméterként várja. Hagyja ki, ha a hívás az Ön teljes bérlői részfáját lefedje; küldje el a hívás egyetlen szervezetre történő szűkítéséhez.

A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

curl -X GET https://api.zinndigital.com/v1/affiliate/referrals \
  -H "Authorization: Bearer zdk_live_…"

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

Gated on affiliate.view. Each row carries the commission terms as they were when that customer converted — plan, rate_bps and duration_months are a snapshot, not a copy of your current line, so the screen shows what each referral actually earns.

Paraméterek

Név	Típus	Kötelező	Mi ez
`org_id (query)`	`string`	Nem	—
`limit (query)`	`integer`	Nem	—
`offset (query)`	`integer`	Nem	—

Válasz

Név	Típus	Kötelező	Mi ez
`items`	`AffiliateReferral[]`	Igen	—
`total`	`integer`	Igen	—
`limit`	`integer`	Igen	—
`offset`	`integer`	Igen	—

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 404