List brand versions

List draft, published and retired versions of a kit.

Outcome

List draft, published and retired versions of a kit.

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

Request

GET /api/brand-kits/{brandKitId}/versions

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
`brandKitId`	Yes	Brand kit identifier in the verified Brand workspace. Read brand_kits.list before selecting it.

Exact published input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "brandKitId": {
      "type": "string",
      "minLength": 1,
      "description": "Brand kit identifier in the verified Brand workspace. Read brand_kits.list before selecting it."
    }
  },
  "required": [
    "brandKitId"
  ],
  "additionalProperties": false
}

Effects

Reads the version history for a kit in the selected workspace.

Interpret the response

versions contains exact identifiers, numeric version, status and snapshots. Missing or inaccessible parent kits can produce an empty list rather than 404; an empty result alone does not establish that the kit exists.

Response identifier contract:

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

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

CLI:

topolo actions validate app_topolo_brand.brand_kit_versions.list --data @payload.json --json
topolo actions plan app_topolo_brand.brand_kit_versions.list --resource-type workspace --resource-id "$BRAND_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_brand.brand_kit_versions.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_kit_versions.list",
    "input": {
      "brandKitId": "brand_c794be50-0306-4933-8de8-5609340bed9e"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>"
  }
}

Captured local response · HTTP 200:

{
  "versions": [
    {
      "id": "brand_version_5d0eb310-87f0-4a81-9f27-11240da457e6",
      "brandKitId": "brand_c794be50-0306-4933-8de8-5609340bed9e",
      "version": 1,
      "status": "draft",
      "snapshot": {
        "identity": {
          "displayName": "Fixture identity",
          "shortDescription": "The next generation of software.",
          "domains": [
            "topolo.io"
          ],
          "locales": [
            "en"
          ]
        },
        "visual": {
          "logos": {
            "primaryAssetId": "brand_asset_dd192c95-76da-4c2e-a61c-8b164686806b"
          },
          "palette": {
            "primary": "#111827",
            "secondary": "#E5E7EB",
            "accent": "#F97316",
            "background": "#FFFFFF",
            "foreground": "#111827",
            "semantic": {}
          },
          "typography": {
            "heading": {
              "family": "Inter",
              "weights": [
                700
              ],
              "fallback": [
                "sans-serif"
              ]
            },
            "body": {
              "family": "Inter",
              "weights": [
                400,
                600
              ],
              "fallback": [
                "sans-serif"
              ]
            }
          },
          "layout": {
            "radius": 16,
            "spacingScale": [
              4,
              8,
              16
            ],
            "logoPlacement": "top-left"
          },
          "imagery": {
            "direction": "Bold, graphic, product-led.",
            "avoid": [
              "generic stock photography"
            ]
          }
        },
        "verbal": {
          "positioning": "Enterprise-grade software without enterprise-era waste.",
          "audiences": [
            "small businesses"
          ],
          "valuePropositions": [
            "One connected software ecosystem"
          ],
          "tone": [
            "bold",
            "direct"
          ],
          "do": [
            "Use specific proof"
          ],
          "dont": [
            "Use unsupported superlatives"
          ],
          "bannedTerms": [
            "guaranteed riches"
          ]
        },
        "claims": [],
        "ctas": [],
        "assets": [
          {
            "id": "brand_asset_dd192c95-76da-4c2e-a61c-8b164686806b",
            "kind": "logo",
            "name": "Fixture logo",
            "url": "/api/brand-assets/brand_asset_dd192c95-76da-4c2e-a61c-8b164686806b/content",
            "mimeType": "image/svg+xml"
          }
        ],
        "accessibility": {
          "minimumContrast": 4.5,
          "requireAltText": true,
          "reducedMotion": true
        },
        "legal": {
          "requiredDisclosures": [],
          "prohibitedTopics": []
        }
      },
      "changeNote": "",
      "createdAt": "2026-10-03T11:23:59.072Z",
      "updatedAt": "2026-10-03T11:23:59.072Z",
      "publishedAt": null
    }
  ]
}

Workflow example

Input · payload.json:

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

CLI:

topolo actions validate app_topolo_brand.brand_kit_versions.list --data @payload.json --json
topolo actions plan app_topolo_brand.brand_kit_versions.list --resource-type workspace --resource-id "$BRAND_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_brand.brand_kit_versions.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_kit_versions.list",
    "input": {
      "brandKitId": "brand_55886012-13a4-4e95-ad31-3fe2b52cdf20"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>"
  }
}

Captured local response · HTTP 200:

{
  "versions": [
    {
      "id": "brand_version_d00e1d23-0626-418b-ba5c-e9c02b746293",
      "brandKitId": "brand_55886012-13a4-4e95-ad31-3fe2b52cdf20",
      "version": 1,
      "status": "draft",
      "snapshot": {
        "identity": {
          "displayName": "Fixture identity",
          "shortDescription": "The next generation of software.",
          "domains": [
            "topolo.io"
          ],
          "locales": [
            "en"
          ]
        },
        "visual": {
          "logos": {
            "primaryAssetId": "brand_asset_87bffee4-7249-419b-b4c1-8edeeb732d55"
          },
          "palette": {
            "primary": "#111827",
            "secondary": "#E5E7EB",
            "accent": "#F97316",
            "background": "#FFFFFF",
            "foreground": "#111827",
            "semantic": {}
          },
          "typography": {
            "heading": {
              "family": "Inter",
              "weights": [
                700
              ],
              "fallback": [
                "sans-serif"
              ]
            },
            "body": {
              "family": "Inter",
              "weights": [
                400,
                600
              ],
              "fallback": [
                "sans-serif"
              ]
            }
          },
          "layout": {
            "radius": 16,
            "spacingScale": [
              4,
              8,
              16
            ],
            "logoPlacement": "top-left"
          },
          "imagery": {
            "direction": "Bold, graphic, product-led.",
            "avoid": [
              "generic stock photography"
            ]
          }
        },
        "verbal": {
          "positioning": "Enterprise-grade software without enterprise-era waste.",
          "audiences": [
            "small businesses"
          ],
          "valuePropositions": [
            "One connected software ecosystem"
          ],
          "tone": [
            "bold",
            "direct"
          ],
          "do": [
            "Use specific proof"
          ],
          "dont": [
            "Use unsupported superlatives"
          ],
          "bannedTerms": [
            "guaranteed riches"
          ]
        },
        "claims": [],
        "ctas": [],
        "assets": [
          {
            "id": "brand_asset_87bffee4-7249-419b-b4c1-8edeeb732d55",
            "kind": "logo",
            "name": "Fixture logo",
            "url": "/api/brand-assets/brand_asset_87bffee4-7249-419b-b4c1-8edeeb732d55/content",
            "mimeType": "image/svg+xml"
          },
          {
            "id": "brand_asset_dce3c24f-65dd-4579-913f-9ffbf74619c9",
            "kind": "logo",
            "name": "Fixture email logo",
            "url": "/api/brand-assets/brand_asset_dce3c24f-65dd-4579-913f-9ffbf74619c9/content",
            "mimeType": "image/png",
            "altText": "Fixture email identity"
          }
        ],
        "accessibility": {
          "minimumContrast": 4.5,
          "requireAltText": true,
          "reducedMotion": true
        },
        "legal": {
          "requiredDisclosures": [],
          "prohibitedTopics": []
        },
        "communications": {
          "emailLogoAssetId": "brand_asset_dce3c24f-65dd-4579-913f-9ffbf74619c9",
          "senderDisplayName": "Fixture identity",
          "replyToAddress": "reply@example.invalid",
          "supportAddress": "support@example.invalid",
          "legalFooter": {
            "entityName": "Fixture identity Ltd",
            "registeredAddress": "1 Fixture Street, Example City",
            "companyNumber": "FIXTURE-001"
          },
          "unsubscribeText": "Manage your message preferences.",
          "footerText": "Synthetic documentation example."
        }
      },
      "changeNote": "A reviewed example draft",
      "createdAt": "2026-10-03T11:23:59.115Z",
      "updatedAt": "2026-10-03T11:23:59.115Z",
      "publishedAt": null
    }
  ]
}

Verify the result

Discover the parent kit first and choose a returned exact version identifier for subsequent operations.

Errors and recovery

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.

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.

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.

List brand versions

Outcome

Before you start

Discover the target

Request

Input fields

Effects

Interpret the response

Worked examples

Minimal example

Workflow example

Verify the result

Errors and recovery

Recovery boundary

Related actions

Evidence