List brand kits

Outcome

List Brand kits in the selected workspace.

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.list --detail --json
topolo resources topolo-brand --json
topolo workspaces list topolo-brand --json

Request

GET /api/brand-kits

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

Use {} as input; credential and workspace resource context remain separate.

Exact published input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Effects

Reads active and retired kit containers and their current published version identifiers.

Interpret the response

brandKits is the scoped array. currentVersionId is null when no published version exists; it does not identify a draft. An empty list is a valid scoped result.

Response identifier contract:

{
  "kind": "brand_kit",
  "identifierSource": "response",
  "idPath": "$.brandKits[].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:

{}

CLI:

topolo actions validate app_topolo_brand.brand_kits.list --data @payload.json --json
topolo actions plan app_topolo_brand.brand_kits.list --resource-type workspace --resource-id "$BRAND_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_brand.brand_kits.list --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.list",
    "input": {},
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>"
  }
}

Captured local response · HTTP 200:

{
  "brandKits": [
    {
      "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
    }
  ]
}

brandKits is the scoped array. currentVersionId is null when no published version exists; it does not identify a draft. An empty list is a valid scoped result.

Workflow example

Input · payload.json:

{}

CLI:

topolo actions validate app_topolo_brand.brand_kits.list --data @payload.json --json
topolo actions plan app_topolo_brand.brand_kits.list --resource-type workspace --resource-id "$BRAND_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_brand.brand_kits.list --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.list",
    "input": {},
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>"
  }
}

Captured local response · HTTP 200:

{
  "brandKits": [
    {
      "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
    }
  ]
}

brandKits is the scoped array. currentVersionId is null when no published version exists; it does not identify a draft. An empty list is a valid scoped result.

Verify the result

Use exact returned kit identifiers and inspect status before creating versions, bindings or resolutions.

Errors and recovery

workspace denied · HTTP 403

{
  "input": {},
  "response": {
    "error": "You do not have access to this workspace",
    "code": "workspace_forbidden"
  }
}

• 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.

• You do not have access to this workspace (HTTP 403): Preserve the exact error and request identifier, inspect the documented constraints, and read back any possibly affected state before retrying.

Recovery boundary

This read or validation does not change Brand service state.

Related actions

• app_topolo_brand.brand_kits.get: Read one Brand kit and the presentation of its current published version.
• app_topolo_brand.brand_kit_versions.list: List draft, published and retired versions of a kit.

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.