---
title: "Get brand kits (v2)"
method: GET
path: "/api/v1/alpha/brand-kits-v2/{id}"
tags: ["alpha"]
---

# Get brand kits (v2)

`GET /api/v1/alpha/brand-kits-v2/{id}`

## Request

- Base URL: `https://point11.ai`
- URL: `https://point11.ai/api/v1/alpha/brand-kits-v2/{id}`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://auth.point11.ai/oauth2/authorize`, token URL `https://auth.point11.ai/oauth2/token`)

Get one Brand Kit by its kit key with its current revision document in its own version, or an exact earlier revision by its artifact id. A version 3 document carries the type scale, colour roles, spacing, radii and components, format guidance, the approved-claims library and terminology to use and avoid; its assetUsage names every asset, .potx and .dotx template packages included.

## Path parameters

- `id` string, required

## Query parameters

- `revision` string, uuid

## Headers

- `Point11-Organization` string, uuid

## Response `200`

Success.

- AlphaBrandKitsGetV2Response
  - `kit` AlphaKit, required
    - `id` string, uuid, required
    - `kitKey` string, required
    - `name` string, required
    - `sourceUrl` string, nullable, required
    - `status` 'active' | 'retired', required
    - `version` integer, required
    - `currentRevisionArtifactId` string, uuid, nullable, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
  - `revision` AlphaRevision2, nullable, required
    - `kitId` string, uuid, required
    - `kitKey` string, required
    - `artifactId` string, uuid, required
    - `revision` integer, required
    - `parentArtifactId` string, uuid, nullable, required
    - `document` union, required
      - AlphaDocument
        - `version` '1', required
        - `name` string, required
        - `colors` object, required
          - `primary` string, required
          - `secondary` string
          - `accent` string
          - `background` string
          - `text` string
          - `palette` string[]
        - `typography` object, required
          - `heading` string, required
          - `body` string, required
        - `logoArtifactIds` string[], required
        - `voiceId` string
        - `doNotRules` string[], required
      - object
        - `version` '2', required
        - `name` string, required
        - `colors` object, required
          - `primary` string, required
          - `secondary` string
          - `accent` string
          - `background` string
          - `text` string
          - `palette` string[]
        - `typography` object, required
          - `heading` string, required
          - `body` string, required
        - `logoArtifactIds` string[], required
        - `voiceId` string
        - `doNotRules` string[], required
        - `writing` object, required
          - `tone` string[], required
          - `audience` string
          - `terminology` string[], required
          - `examples` string[], required
        - `layout` object, required
          - `description` string
          - `spacing` string[], required
          - `corners` string
          - `buttons` string
          - `imagery` string
          - `responsive` string
          - `documentTemplate` string
          - `presentationTemplate` string
          - `spreadsheetTemplate` string
          - `adTemplate` string
          - `websiteTemplate` string
        - `evidence` object, required
          - `sourceUrl` string, uri
          - `finalUrl` string, uri
          - `observedAt` string, date-time
          - `sources` object[], required
            - `url` string, uri, required
            - `observation` string, required
          - `gaps` string[], required
        - `assetUsage` object[], required
          - `artifactId` string, uuid, required
          - `role` 'logo' | 'logo_dark' | 'icon' | 'image' | 'font_heading' | 'font_body' | 'screenshot' | 'template' | 'reference', required
          - `mediaType` 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' | 'application/vnd.openxmlformats-officedocument.presentationml.presentation' | 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' | 'application/pdf' | 'application/vnd.openxmlformats-officedocument.presentationml.template' | 'application/vnd.openxmlformats-officedocument.wordprocessingml.template' | 'image/png' | 'image/jpeg' | 'image/webp' | 'image/svg+xml' | 'font/woff' | 'font/woff2' | 'font/ttf' | 'font/otf'
          - `label` string, required
          - `sourceUrl` string, uri
          - `usage` 'reference_only' | 'web' | 'embed' | 'unavailable', required
          - `restriction` string
          - `licence` object
            - `basis` 'customer_asserted', required
            - `assertedAt` string, date-time
        - `overrides` object[], required
          - `field` 'name' | 'colors' | 'typography' | 'logoArtifactIds' | 'voiceId' | 'doNotRules' | 'writing' | 'layout' | 'assetUsage', required
          - `action` 'set' | 'remove', required
          - `source` 'customer' | 'import', required
      - object
        - `version` '3', required
        - `name` string, required
        - `colors` object, required
          - `primary` string, required
          - `secondary` string
          - `accent` string
          - `background` string
          - `surface` string
          - `text` string
          - `mutedText` string
          - `border` string
          - `success` string
          - `warning` string
          - `error` string
          - `palette` string[]
        - `typography` object, required
          - `heading` string, required
          - `body` string, required
          - `mono` string
          - `scale` object[], required
            - `name` string, required
            - `family` 'heading' | 'body' | 'mono', required
            - `weight` integer, required
            - `sizePx` number, required
            - `lineHeight` number, required
            - `letterSpacingEm` number
        - `logoArtifactIds` string[], required
        - `voiceId` string
        - `doNotRules` string[], required
        - `writing` object, required
          - `tone` string[], required
          - `audience` string
          - `terminology` string[], required
          - `examples` string[], required
          - `vocabulary` object, required
            - `use` object[], required
              - …
            - `avoid` object[], required
              - …
        - `layout` object, required
          - `description` string
          - `spacing` string[], required
          - `corners` string
          - `buttons` string
          - `imagery` string
          - `responsive` string
        - `guidance` object, required
          - `document` string
          - `presentation` string
          - `spreadsheet` string
          - `ad` string
          - `website` string
        - `tokens` object, required
          - `spacing` number[], required
          - `radii` object[], required
            - `name` string, required
            - `px` number, required
          - `components` object[], required
            - `name` string, required
            - `description` string
            - `background` string
            - `foreground` string
            - `border` string
            - `borderWidthPx` number
            - `radiusPx` number
            - `paddingYPx` number
            - `paddingXPx` number
            - `typeStep` string
        - `claims` object[], required
          - `claim` string, required
          - `proof` string, required
          - `proofUrl` string, uri
          - `expiresOn` string, date
        - `evidence` object, required
          - `sourceUrl` string, uri
          - `finalUrl` string, uri
          - `observedAt` string, date-time
          - `sources` object[], required
            - `url` string, uri, required
            - `observation` string, required
          - `gaps` string[], required
        - `assetUsage` object[], required
          - `artifactId` string, uuid, required
          - `role` 'logo' | 'logo_dark' | 'icon' | 'image' | 'font_heading' | 'font_body' | 'screenshot' | 'template' | 'reference', required
          - `mediaType` 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' | 'application/vnd.openxmlformats-officedocument.presentationml.presentation' | 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' | 'application/pdf' | 'application/vnd.openxmlformats-officedocument.presentationml.template' | 'application/vnd.openxmlformats-officedocument.wordprocessingml.template' | 'image/png' | 'image/jpeg' | 'image/webp' | 'image/svg+xml' | 'font/woff' | 'font/woff2' | 'font/ttf' | 'font/otf'
          - `label` string, required
          - `sourceUrl` string, uri
          - `usage` 'reference_only' | 'web' | 'embed' | 'unavailable', required
          - `restriction` string
          - `licence` object
            - `basis` 'customer_asserted', required
            - `assertedAt` string, date-time
        - `overrides` object[], required
          - `field` 'name' | 'colors' | 'typography' | 'logoArtifactIds' | 'voiceId' | 'doNotRules' | 'writing' | 'layout' | 'assetUsage' | 'guidance' | 'tokens' | 'claims', required
          - `action` 'set' | 'remove', required
          - `source` 'customer' | 'import', required
    - `origin` 'extraction' | 'manual' | 'chat', required
    - `createdAt` string, date-time, required

## Other responses

- `400`: The input, query, or Idempotency-Key is invalid.
- `401`: The bearer is missing, expired, or not accepted.
- `403`: The credential lacks the operation's scope or role, or the operation needs a different door.
- `404`: The resource or organization does not exist for this caller.
- `405`: This path takes another HTTP method, named in `Allow`.
- `409`: The request conflicts with current state or with prior use of its Idempotency-Key.
- `413`: The request, or the answer it asks for, is too large; narrow it.
- `429`: The credential's rate budget is spent; retry after `Retry-After` seconds.
- `500`: An unexpected server failure; retry later. Only `request_id` identifies it.
- `503`: A dependency is temporarily unavailable; retry after `Retry-After` seconds.
- `default`: Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.

---

[API](https://skmtc.dev/point11/apis/point11-api.md) · [All operations](https://skmtc.dev/point11/apis/point11-api/llms.txt) · [OpenAPI document](https://skmtc.dev/point11/apis/point11-api/revisions/5241805fe425?raw)