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

# Get brand kit workspaces (v2)

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

## Request

- Base URL: `https://point11.ai`
- URL: `https://point11.ai/api/v1/alpha/brand-kit-workspaces-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 the Brand Kit inventory for the organization (id "organization"), one business profile (its id), or the business profile selected by default (id "default", which profileBinding names; the organization when it has no active profile): each kit's default or active status and the defaults' versions. A named kit's revision a file import added reads with origin manual. Name a kit to also get it, its revision with its document in its own version (version 3 included, every asset named, .potx and .dotx template packages included), and its first page of runs.

## Path parameters

- `id` union, required
  - 'organization'
  - 'default'
  - string, uuid

## Query parameters

- `kitPage` integer
- `query` string: Only kits whose name contains this text, ignoring case
- `sort` 'updatedAt' | 'name': updatedAt: the kit's last change. name: ignoring case
- `direction` 'asc' | 'desc'
- `status` 'active' | 'archived': Which kits to list: active ones, or archived (retired) ones, read only
- `kit` string
- `revision` string, uuid

## Headers

- `Point11-Organization` string, uuid

## Response `200`

Success.

- AlphaBrandKitWorkspacesGetV2Response
  - `kits` object[], 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
    - `listStatus` 'default' | 'active' | 'retired', required
  - `kitPage` integer, required
  - `hasMoreKits` boolean, required
  - `totalCount` integer, required
  - `defaultKitId` string, uuid, nullable, required
  - `defaults` object, required
    - `kitId` string, uuid, nullable, required
    - `version` integer, required
  - `profileBinding` object, nullable, required
    - `profileId` string, uuid, required
    - `kitId` string, uuid, nullable, required
    - `version` integer, required
  - `selected` object, nullable, required
    - `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
              - …
            - `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
              - …
          - `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
              - …
          - `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
              - …
          - `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
              - …
            - `components` object[], required
              - …
          - `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
              - …
            - `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
              - …
          - `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
    - `runs` AlphaBrandKitRunsListResponse, required
      - `data` object[], required
        - `runId` string, uuid, required
        - `outcome` 'published' | 'candidate' | 'unavailable' | 'failed', nullable, required
        - `failureCode` string, nullable, required
        - `error` string, nullable, required
        - `createdAt` string, date-time, required
        - `completedAt` string, date-time, nullable, required
        - `executionStatus` 'scheduled' | 'waiting' | 'running' | 'completed' | 'failed' | 'cancelled', nullable, required
      - `nextCursor` string, nullable, 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/36a84c7aca11?raw)