affiliate
GET /v1/affiliate
Your affiliate account, your earnings, and the lines you can choose from.
Authentication
Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/affiliate \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Gated on `affiliate.view`. Answers `200` with `account: null` when this organisation has not joined — "you are not an affiliate yet" is a normal state of a screen every customer can open, not an error. `totals.by_currency` is grouped by currency and deliberately **not** summed across them: adding 100 GBP to 100 EUR produces a number that is wrong in both. `plans` is served from the engine rather than hardcoded in a console, so a rate the owner changes cannot disagree with the rate a customer read before signing up.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | string | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
account | AffiliateAccount | Yes | — |
totals | AffiliateTotals | Yes | — |
plans | AffiliateCommissionPlan[] | Yes | — |
Errors this endpoint can return
401 · 403 · 404