reseller
GET /v1/reseller/overview
Everything you have — every URL, credential and setting, in one read.
Authentication
Send an API key as a bearer token. The key must carry the reseller.view permission; a key without it is refused with 403, not 404.
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/reseller/overview \
-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
The reseller reference card: the address your clients sign in at, the nameservers you hand them, your sending domain, your API base and key counts, where your clients' support goes, which product lines you sell, how many languages their panel offers, and how many client accounts you run. Every block carries the route that changes it, and the gaps (`gateway_gap`, `invoicing_gap`, `support.gap`) are reported as booleans so a screen can say what is missing rather than render a blank field. Requires `reseller.view`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | Uuid | No | Which of your organizations this applies to. Required only when you belong to more than one here — otherwise it is inferred, and an id outside your direct memberships is a 404 r… |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
program | ResellerOverviewProgram | Yes | — |
panel | ResellerOverviewPanel | Yes | — |
mail | ResellerOverviewMail | Yes | — |
dns | ResellerOverviewDns | Yes | — |
api | ResellerOverviewApi | Yes | — |
support | ResellerOverviewSupport | Yes | — |
commerce | ResellerOverviewCommerce | Yes | — |
languages | ResellerOverviewLanguages | Yes | — |
notifications | ResellerOverviewNotifications | Yes | — |
clients | ResellerOverviewClients | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 429