reseller

GET /v1/reseller/services/{siteId}

One provisioned service.

All reseller endpoints

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/services/{siteId} \
  -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 same row `listResellerServices` returns, for one site. A site outside your client subtree is a 404, never a 403 — so this is not an existence oracle. Requires `reseller.view`.

Parameters

NameTypeRequiredWhat it is
siteId (path)UuidYesSite ID (UUIDv7).
org_id (query)UuidNoWhich of your organizations this applies to. Required only when you belong to more than one here.

Response

NameTypeRequiredWhat it is
site_idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
client_org_idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
client_org_namestringYes
primary_domainstringYes
namestringNo
statusSiteStatusYesA site's lifecycle state (docs/04 §3). A newly created site is `pending` until the provisioning workflow picks it up; `deleted` is terminal. `restricted` and `quarantined` are t…
product_lineobjectNo
plan_codeobjectNo
plan_nameobjectNo
held_by_resellerbooleanNoTrue when the current suspension was placed through this surface, which is the only case `unsuspendResellerService` will release. A site suspended by the abuse desk reports fals…
pending_deletion_atobjectNoWhen a scheduled deletion falls due, or null.
sell_amount_minorobjectNoWhat YOU charge for this plan, in minor units of `sell_currency` — your own price-list row if you have authored one, otherwise our list price with your default markup applied. N…
sell_currencyobjectNo
created_atstringYes
disk_used_bytesobjectNoNull when the hosting platform has no usage to report for this site.
bandwidth_used_bytesobjectNoOutbound bandwidth this billing period, or null.
usage_measured_atobjectNoWhen the reading was taken. Null alongside null usage — so "we have not measured this" is never mistaken for "it used nothing" (§2.44).

Errors this endpoint can return

401 · 403 · 404 · 429