affiliate

GET `/v1/affiliate/referrals`

The customers who signed up through your links.

Uwierzytelnianie

Wyślij klucz API jako token bearer. Ten punkt końcowy nie określa konkretnego uprawnienia w specyfikacji, więc nadaj swojemu kluczowi minimum potrzebnych uprawnień i sprawdź odpowiedź zamiast zakładać.

Miejsce na identyfikator organizacji

Ten punkt końcowy przyjmuje org_id jako parametr zapytania. Pomiń go, a wywołanie obejmie całe drzewo dzierżawy; prześlij go, aby ograniczyć wywołanie do jednej organizacji.

Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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.

Parametry

Nazwa	Typ	Wymagane	Co to jest
`org_id (query)`	`string`	Nie	—
`limit (query)`	`integer`	Nie	—
`offset (query)`	`integer`	Nie	—

Odpowiedź

Nazwa	Typ	Wymagane	Co to jest
`items`	`AffiliateReferral[]`	Tak	—
`total`	`integer`	Tak	—
`limit`	`integer`	Tak	—
`offset`	`integer`	Tak	—

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404