> ## Documentation Index
> Fetch the complete documentation index at: https://docs.adside.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get

> Get a brand kit

CLI: `adside brands get`



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/workspaces/{workspaceId}/brand-kits/{brandKitId}
openapi: 3.1.0
info:
  title: Adside API
  version: 1.0.0
  description: >-
    Campaigns, creatives, assets and reporting across your ad accounts. Call it
    with a personal API key as a bearer token, or with the `adside` CLI: each
    page names its command.
servers:
  - url: https://api.adside.ai
    description: Production
security:
  - userAccess: []
tags:
  - name: Account
  - name: Reporting
  - name: Meta
  - name: Google Ads
  - name: LinkedIn
  - name: TikTok
  - name: Reddit
  - name: Snapchat
  - name: X
  - name: Google Tag Manager
  - name: Creatives
  - name: Creative styles
  - name: Media
  - name: Characters
  - name: Assets
  - name: Brands
  - name: Brain
  - name: Research
  - name: Boards
  - name: Artifacts
  - name: Audiences
  - name: Ad comments
  - name: Publications
  - name: Routines
  - name: Skills
  - name: To-dos
  - name: Audit
  - name: Credits
paths:
  /v1/workspaces/{workspaceId}/brand-kits/{brandKitId}:
    get:
      tags:
        - Brands
      summary: Get
      description: |-
        Get a brand kit

        CLI: `adside brands get`
      operationId: brands.get
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
        - name: brandKitId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  brandKit:
                    type: object
                    properties:
                      profileVersion:
                        anyOf:
                          - type: string
                          - type: 'null'
                      profileExtractedAt:
                        anyOf:
                          - type: string
                          - type: 'null'
                      creativeKitStatus:
                        anyOf:
                          - type: string
                            enum:
                              - QUEUED
                              - RUNNING
                              - READY
                              - FAILED
                          - type: 'null'
                      creativeKitJobId:
                        anyOf:
                          - type: string
                          - type: 'null'
                      creativeKitVersion:
                        anyOf:
                          - type: string
                          - type: 'null'
                      creativeKitRevision:
                        anyOf:
                          - type: string
                          - type: 'null'
                      creativeKitScannedAt:
                        anyOf:
                          - type: string
                          - type: 'null'
                      creativeKitPublishedAt:
                        anyOf:
                          - type: string
                          - type: 'null'
                      creativeKitError:
                        anyOf:
                          - type: string
                          - type: 'null'
                      creativeKitProgress:
                        anyOf:
                          - {}
                          - type: 'null'
                      id:
                        type: string
                      name:
                        type: string
                      isDefault:
                        type: boolean
                      companyName:
                        type: string
                      tagline:
                        anyOf:
                          - type: string
                          - type: 'null'
                      logo:
                        anyOf:
                          - type: string
                            format: uri
                          - type: 'null'
                      icon:
                        anyOf:
                          - type: string
                            format: uri
                          - type: 'null'
                      brandColors:
                        type: array
                        items:
                          type: string
                          pattern: ^#[0-9A-Fa-f]{6}$
                      toneOfVoice:
                        type: array
                        items:
                          type: string
                      marketPositioning:
                        anyOf:
                          - type: string
                          - type: 'null'
                      industry:
                        anyOf:
                          - type: string
                          - type: 'null'
                      vertical:
                        anyOf:
                          - type: string
                          - type: 'null'
                      websiteUrl:
                        anyOf:
                          - type: string
                          - type: 'null'
                      evidence:
                        anyOf:
                          - {}
                          - type: 'null'
                      evidenceExtractedAt:
                        anyOf:
                          - type: string
                          - type: 'null'
                      evidenceRefreshStatus:
                        anyOf:
                          - type: string
                            enum:
                              - PENDING
                              - READY
                              - FAILED
                          - type: 'null'
                      workspaceId:
                        anyOf:
                          - type: string
                          - type: 'null'
                      organizationId:
                        anyOf:
                          - type: string
                          - type: 'null'
                      createdAt:
                        type: string
                      updatedAt:
                        type: string
                    required:
                      - id
                      - name
                      - isDefault
                      - companyName
                      - tagline
                      - logo
                      - icon
                      - brandColors
                      - toneOfVoice
                      - marketPositioning
                      - industry
                      - vertical
                      - websiteUrl
                      - workspaceId
                      - organizationId
                      - createdAt
                      - updatedAt
                    additionalProperties: false
                required:
                  - brandKit
                additionalProperties: false
      security:
        - userAccess: []
components:
  securitySchemes:
    userAccess:
      type: http
      scheme: bearer
      description: >-
        A personal API key (`adside_pat_…`) or a token from `adside login`.
        Either carries the permissions of the person it belongs to.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.