reseller

GET /v1/reseller/brand/menu

Your custom navigation links.

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/brand/menu \
  -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 links you have added to your clients' panel, plus the icons and limits the form needs. Requires `reseller.view`. ⭐ Returns **every** item including staff-only ones, unlike `GET /v1/branding` which filters. That is not an inconsistency: this is your own editing surface and you are the author of every row, so hiding your own configuration from you would make the list disagree with what saving it does.

Parameters

NameTypeRequiredWhat it is
org_id (query)UuidNoThe organization this call acts on. Optional for a caller with exactly one direct membership; **required** for anyone with more than one — which is every reseller and every agen…

Response

NameTypeRequiredWhat it is
itemsBrandMenuItem[]Yes
entitledbooleanYes
max_itemsintegerYesHow many links fit alongside the panel's own navigation. Served with the data so the app cannot hold a limit that disagrees with the engine.
iconsstring[]Yes
visibilitiesstring[]Yes

Errors this endpoint can return

401 · 403