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

# Get the brand's content guideline document



## OpenAPI

````yaml /api-reference/openapi.json get /api/v2/brands/{brand_id}/content_studio/brand_guidelines
openapi: 3.0.1
info:
  title: Cognizo Public API
  version: v1
  description: >-
    Public REST API for Cognizo. Authenticate with an API key via the
    `X-API-KEY` header.
servers:
  - url: https://core.cognizo.ai
security:
  - apiKey: []
paths:
  /api/v2/brands/{brand_id}/content_studio/brand_guidelines:
    parameters:
      - name: brand_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
    get:
      tags:
        - ContentStudio
      summary: Get the brand's content guideline document
      operationId: get_brand_content_studio_brand_guidelines
      responses:
        '200':
          description: guidelines returned (empty envelope when never edited)
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/content_studio_brand_guideline'
                required:
                  - data
        '403':
          description: >-
            organization access revoked (ORGANIZATION_ACCESS_REVOKED): the
            access token's organization is no longer one of the user's
            memberships (they left, were removed, or the organization was
            deleted). The session itself is still valid: drop the organization's
            client state and refresh the session, which moves it to another
            organization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: brand not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '500':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
components:
  schemas:
    content_studio_brand_guideline:
      type: object
      properties:
        id:
          type: string
          format: uuid
          nullable: true
          description: >-
            Null until the first PATCH persists the row (GET on a never-edited
            brand returns the empty defaults)
        brand_id:
          type: string
          format: uuid
        foundations:
          type: object
          additionalProperties: true
          description: about / voice_tone / author_persona / dos / donts / lexicon
        logo:
          type: object
          description: >-
            Per-slot S3 keys + freshly signed GET URLs (bucket is private;
            `<slot>_url` is re-signed on every read and expires — persist the
            `_key`, not the `_url`)
          properties:
            primary_logo_key:
              type: string
              nullable: true
            primary_logo_url:
              type: string
              nullable: true
            wordmark_key:
              type: string
              nullable: true
            wordmark_url:
              type: string
              nullable: true
            favicon_key:
              type: string
              nullable: true
            favicon_url:
              type: string
              nullable: true
            author_photo_key:
              type: string
              nullable: true
            author_photo_url:
              type: string
              nullable: true
          additionalProperties: true
        colors:
          type: object
          additionalProperties: true
          description: '{ brand: [...], neutrals: [...] } palettes'
        seeded:
          type: boolean
          description: >-
            Whether the guideline row exists yet (the async site-audit seeder
            has run); false while the GET is serving unpersisted defaults
        confirmed_at:
          type: string
          format: date-time
          nullable: true
          description: When the brand confirmed its look (POST …/confirm); null until then
        updated_at:
          type: string
          format: date-time
          nullable: true
      required:
        - brand_id
        - foundations
        - logo
        - colors
        - seeded
        - confirmed_at
    error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Stable machine-readable reason; see `error_code`.
            message:
              type: string
            details:
              type: array
              items:
                $ref: '#/components/schemas/error_detail'
          required:
            - code
            - message
      required:
        - error
    error_detail:
      type: object
      properties:
        field:
          type: string
          nullable: true
        code:
          type: string
        message:
          type: string
      required:
        - code
        - message
        - field
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-KEY

````

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