Get brand kit

Read one Brand kit and the presentation of its current published version.

Outcome

Read one Brand kit and the presentation of its current published version.

Before you start

Verify whoami and the pinned credential context, then inspect the exact discovered action before preparing input.
Discover a granted Brand workspace. Pass its resourceType/workspace identifier separately from input; a copied fixture identifier grants no access.
The declared permission is brand:read. The active credential, application scope, resource binding and runtime authority must all authorize the request.

Discover the target

topolo whoami --json
topolo actions get app_topolo_brand.brand_kits.get --detail --json
topolo resources topolo-brand --json
topolo workspaces list topolo-brand --json

Request

GET /api/brand-kits/{id}

Resource context is the selected Brand workspace. CLI/SDK action input includes path identifiers; direct HTTP JSON bodies exclude path parameters. Read the reviewed plan for the exact request.

Input fields

Field	Required	Meaning
`id`	Yes	Exact kit or binding identifier from the corresponding list action; its meaning is determined by this action.

Exact published input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "Exact kit or binding identifier from the corresponding list action; its meaning is determined by this action."
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Effects

Reads one workspace-scoped kit without changing its metadata or snapshots.

Interpret the response

brandKit is the container. presentation is null before publication, otherwise the stable topolo.brand.presentation/v1 rendering projection. Unset optional presentation fields are null. Kit metadata and snapshot identity are separate.

Response identifier contract:

{
  "kind": "brand_kit",
  "identifierSource": "response",
  "idPath": "$.brandKit.id"
}

Worked examples

These complete synthetic responses were captured from the local worker over canonical SQL migrations. Auth and R2 dependencies are simulated; notification delivery is not exercised. Set BRAND_WORKSPACE_ID from granted workspace discovery. Save reviewed input as payload.json, validate and inspect the unchanged plan. The final mutation command and MCP confirm flag assume the intended effect has already been authorized.

Minimal example

Input · payload.json:

{
  "id": "brand_c794be50-0306-4933-8de8-5609340bed9e"
}

CLI:

topolo actions validate app_topolo_brand.brand_kits.get --data @payload.json --json
topolo actions plan app_topolo_brand.brand_kits.get --resource-type workspace --resource-id "$BRAND_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_brand.brand_kits.get --resource-type workspace --resource-id "$BRAND_WORKSPACE_ID" --data @payload.json --json

MCP tool and arguments:

{
  "tool": "topolo_read_action",
  "arguments": {
    "actionId": "app_topolo_brand.brand_kits.get",
    "input": {
      "id": "brand_c794be50-0306-4933-8de8-5609340bed9e"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>"
  }
}

Captured local response · HTTP 200:

{
  "brandKit": {
    "id": "brand_c794be50-0306-4933-8de8-5609340bed9e",
    "organizationId": "org_documentation_fixture",
    "name": "Fixture identity",
    "slug": "fixture-minimal",
    "description": "",
    "status": "active",
    "createdAt": "2026-10-03T11:23:59.056Z",
    "updatedAt": "2026-10-03T11:23:59.056Z",
    "currentVersionId": null
  },
  "presentation": null
}

Workflow example

Input · payload.json:

{
  "id": "brand_55886012-13a4-4e95-ad31-3fe2b52cdf20"
}

CLI:

topolo actions validate app_topolo_brand.brand_kits.get --data @payload.json --json
topolo actions plan app_topolo_brand.brand_kits.get --resource-type workspace --resource-id "$BRAND_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_brand.brand_kits.get --resource-type workspace --resource-id "$BRAND_WORKSPACE_ID" --data @payload.json --json

MCP tool and arguments:

{
  "tool": "topolo_read_action",
  "arguments": {
    "actionId": "app_topolo_brand.brand_kits.get",
    "input": {
      "id": "brand_55886012-13a4-4e95-ad31-3fe2b52cdf20"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>"
  }
}

Captured local response · HTTP 200:

{
  "brandKit": {
    "id": "brand_55886012-13a4-4e95-ad31-3fe2b52cdf20",
    "organizationId": "org_documentation_fixture",
    "name": "Fixture identity",
    "slug": "fixture-workflow",
    "description": "A governed example identity",
    "status": "active",
    "createdAt": "2026-10-03T11:23:59.104Z",
    "updatedAt": "2026-10-03T11:23:59.104Z",
    "currentVersionId": null
  },
  "presentation": null
}

Verify the result

Compare brandKit.id, currentVersionId and presentation.versionId. Build rendering adapters on presentation; use an exact version read when preserving provenance.

Errors and recovery

refused · HTTP 404

{
  "input": {
    "id": "missing-fixture"
  },
  "response": {
    "error": "brand_kit_not_found"
  }
}

auth_error (HTTP 401): CLI/SDK authentication classification when Auth returns a non-code message: restore the authorized credential, then verify whoami and context. Preserve the exact service message.
permission_denied (HTTP 403): Use the exact permission and granted resource required by the reviewed action; organization membership alone is insufficient.
workspace_required (HTTP 400): Discover and select a granted Brand workspace before preparing the request.
brand_storage_unavailable (HTTP 503): The Brand storage bindings are unavailable. Preserve the request identifier and report the service fault; do not retry an unverified mutation.
brand_kit_not_found (HTTP 404): Discover the exact parent/resource again and inspect its lifecycle status. Missing, inaccessible or immutable resources can share this refusal.

Recovery boundary

This read or validation does not change Brand service state.

app_topolo_brand.brand_kit_versions.get: Read an exact Brand version and its rendering presentation.
app_topolo_brand.brand_kits.resolve_context: Resolve the first eligible brand for a consumer context.

Evidence

Four real local SQLite stores use all canonical migrations; Auth identity/grants and archival plus R2 object storage are explicitly simulated. Notifications are disabled in fixtures. No notification delivery, live mutation, gateway credential parity or deployed environment proof is claimed. Fixture identifiers and timestamps are synthetic and must be replaced by exact authorized resource discovery.

Documentation history

2026-10-18

Aligned the precise response schema with reviewed Brand source, including the rendering presentation fields for logos, typography and layout.
Retained both captured responses with presentation: null; no missing presentation was filled in or inferred.
Reviewed source revision a4b22b76664478536809b7a438232645661175b6 and retained 2 request/response captures from the documented fixture lineage. Auth/workspace grants and object storage remain simulated; notifications were disabled. No new test execution or deployed environment validation is established.
This entry records a documentation correction; product release version, release date and runtime adoption are not inferred.