agency-board
GET /v1/boards/brand
The branding your shared boards carry.
Authentication
Send an API key as a bearer token. The key must carry the agency.board.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/boards/brand \
-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 name, mark and colour that people opening one of your board share links see — instead of ours. Requires agency.board.view. ⛔ A brand you have not set up yet is a 200 with configured: false, never a 404: the screen renders an empty form either way. ⛔ entitled is computed on the shared-board surface specifically. Boards Business sells branding for shared boards and not platform-wide white-label, so this answers a narrower question than GET /v1/reseller/brand's field of the same name — and answering the wider one here would tell a paying customer their branding does nothing.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | Uuid | No | The 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 agency… |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
configured | boolean | Yes | Whether a brand row exists yet. False renders an empty form, not a 404. |
entitled | boolean | Yes | Whether branding on shared boards is on this org's plan. ⛔ Computed on the shared-board surface, so a Boards Business org reads true here while holding no platform-wide… |
surface | string | Yes | Which branding surface this answer is about. Always shared_board. |
name | string | Yes | — |
logo_url | string | Yes | Where the stored mark is served from, or empty. Read-only — the logo is an upload. |
primary_colour | string | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 429